Public Member Functions
void	addConsent (@XmlElement(required=true) @WebParam(name="consentDTO") ConsentDTO consentDTO) throws UnknownDomainException, UnknownModuleException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, MissingRequiredObjectException, InvalidFreeTextException, MandatoryFieldsException, UnknownSignerIdTypeException, DuplicateEntryException
	stores the given consent the policies within the modulDTOs are ignored and therefore doesn't need to be set More...

boolean	isConsented (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO policyKeyDTO, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given specific version More...

boolean	isConsentedFromIncludingToIncluding (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from <= version <= to ignores the config parameter "ignoreVersionNumber" More...

boolean	isConsentedFromExcludingToIncluding (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from < version <= to ignores the config parameter "ignoreVersionNumber" More...

boolean	isConsentedFromIncludingToExcluding (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from <= version < to ignores the config parameter "ignoreVersionNumber" More...

boolean	isConsentedFromExcludingToExcluding (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from < version < to ignores the config parameter "ignoreVersionNumber" More...

ConsentStatusType	getConsentStatusType (@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO policyKeyDTO, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given specific version More...

ConsentStatusType	getConsentStatusTypeFromIncludingToIncluding ( @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from <= version <= to ignores the config parameter "ignoreVersionNumber" More...

ConsentStatusType	getConsentStatusTypeFromExcludingToIncluding ( @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from < version <= to ignores the config parameter "ignoreVersionNumber" More...

ConsentStatusType	getConsentStatusTypeFromIncludingToExcluding ( @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from <= version < to ignores the config parameter "ignoreVersionNumber" More...

ConsentStatusType	getConsentStatusTypeFromExcludingToExcluding ( @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="versionFrom") String versionFrom, @XmlElement(required=true) @WebParam(name="versionTo") String versionTo, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	checks whether there's a signed consent for the given patient and policy in the given version range: from < version < to ignores the config parameter "ignoreVersionNumber" More...

List< ConsentTemplateDTO >	listConsentTemplates (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
	lists all consent templates of the given domain More...

List< ConsentTemplateDTO >	listCurrentConsentTemplates (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
	lists the most recent version of all consent templates of the given domain More...

void	addConsentTemplate (@XmlElement(required=true) @WebParam(name="consentTemplate") ConsentTemplateDTO consentTemplateDTO) throws UnknownDomainException, UnknownModuleException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, FreeTextConverterStringException, InvalidPropertiesException
	stores the given consent template the policies within the modulDTOs are ignored and therefore doesn't need to be set More...

void	deleteConsentTemplate (@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO keyDTO) throws UnknownDomainException, UnknownConsentTemplateException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
	deletes the given consent template (only if it's not in use, i.e. More...

List< ModuleDTO >	listModules (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
	lists all modules of the given domain More...

void	addModule (@XmlElement(required=true) @WebParam(name="module") ModuleDTO moduleDTO) throws UnknownDomainException, UnknownPolicyException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException
	stores the given module More...

void	deleteModule (@XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO keyDTO) throws UnknownDomainException, UnknownModuleException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
	deletes the given module (only if it's not in use, i.e. More...

ModuleDTO	getModule (@XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO keyDTO) throws UnknownDomainException, UnknownModuleException, VersionConverterClassException, InvalidVersionException
	returns all attributes of the requested module More...

List< PolicyDTO >	listPolicies (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
	lists all policies of the given domain More...

void	addPolicy (@XmlElement(required=true) @WebParam(name="policy") PolicyDTO policyDTO) throws UnknownDomainException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException
	stores the given policy More...

void	deletePolicy (@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO keyDTO) throws UnknownDomainException, UnknownPolicyException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
	deletes the given policy (only if it's not in use, i.e. More...

PolicyDTO	getPolicy (@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO keyDTO) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException
	returns all attributes of the requested policy More...

ConsentTemplateDTO	getConsentTemplate (@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO keyDTO) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException
	returns all attributes of the requested consent template More...

ConsentTemplateDTO	getCurrentConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplateName") String consentTemplateName, @XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException
	returns all attributes of the current (highest version) consent template with the given name More...

List< SignedPolicyDTO >	getPolicyStatesForSigner (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	returns all signed policies which are signed by the person with the given id More...

List< SignedPolicyDTO >	getPolicyStatesForPolicyAndSigner ( @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO policyKeyDTO, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	returns all signed policies for the given policy which are signed by the person with the given id More...

List< SignedPolicyDTO >	getPolicyStatesForPolicyNameAndSigner (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="policyName") String policyName, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	returns all signed policies for the given policy name (thus ignoring the version number of the policy) which are signed by the person with the given id More...

List< ConsentLightDTO >	getAllConsentsForPerson (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException
	lists all consents for the person with the given id More...

ConsentDTO	getCurrentConsentForPersonAndCT ( @XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO ctKeyDTO, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs, @XmlElement(required=true) @WebParam(name="ignoreVersionNumber") boolean ignoreVersionNumber) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException
	returns the current consent for the given signerIds current means: the consent with the highest versionNumber of the associated ConsentTemplate; if there are more then one, the newest (ConsentDate) of them if "ignoreVersionNumber" is true, then the newest of all consents belonging to the signerIds, regardless of the VersionNumber of the associated ConsentTemplate More...

List< ConsentLightDTO >	getAllConsentsForConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO ctKeyDTO) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
	lists all consents for the given consent template More...

List< ConsentLightDTO >	getAllConsentsForDomain (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
	lists all consents for the given domain More...

List< ConsentLightDTO >	getAllConsentsForDomainWithoutScan (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
	lists all consents for the given domain which doesn't have a scan attached More...

List< ConsentLightDTO >	getConsentsForDomainPaginated (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="firstEntry") int firstEntry, @XmlElement(required=true) @WebParam(name="pageSize") int pageSize, @XmlElement(required=true) @WebParam(name="sortField") ConsentField sortField, @XmlElement(required=true) @WebParam(name="sortIsAscending") boolean sortIsAscending, @XmlElement(required=true) @WebParam(name="filter") HashMapWrapper< ConsentField, Object > filter) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
	lists consents for the given domain with pagination More...

ConsentDTO	getConsent (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO keyDTO) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException, UnknownConsentTemplateException, UnknownSignerIdTypeException, UnknownConsentException
	get the complete dto for the given key - thought to be used in addition to the list functions More...

void	addDomain (@XmlElement(required=true) @WebParam(name="domain") DomainDTO domainDTO) throws DuplicateEntryException, VersionConverterClassException
	creates a new domain More...

void	deleteDomain (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws ObjectInUseException, UnknownDomainException
	deletes the given domain More...

DomainDTO	getDomain (@XmlElement(required=true) @WebParam(name="domainName") String domainName) throws UnknownDomainException
	returns all information for the given domain More...

List< DomainDTO >	listDomains ()

void	updateDomain (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="label") String label, @XmlElement(required=true) @WebParam(name="logo") String logo, @XmlElement(required=true) @WebParam(name="externProperties") String externProperties, @XmlElement(required=true) @WebParam(name="comment") String comment) throws UnknownDomainException
	updates the given domain More...

void	updateConsentTemplate (@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO consentTemplateKey, @XmlElement(required=true) @WebParam(name="title") String title, @XmlElement(required=true) @WebParam(name="externProperties") String externProperties, @XmlElement(required=true) @WebParam(name="comment") String comment, @XmlElement(required=true) @WebParam(name="scanBase64") String scanBase64, @XmlElement(required=true) @WebParam(name="scanFileType") String scanFileType) throws UnknownDomainException, UnknownConsentTemplateException, InvalidVersionException, VersionConverterClassException
	updates the given consent template More...

void	updatePolicy (@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO policyKey, @XmlElement(required=true) @WebParam(name="externProperties") String externProperties, @XmlElement(required=true) @WebParam(name="comment") String comment) throws UnknownDomainException, UnknownPolicyException, InvalidVersionException, VersionConverterClassException
	updates the given policy More...

void	updateModule (@XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO moduleKey, @XmlElement(required=true) @WebParam(name="title") String title, @XmlElement(required=true) @WebParam(name="externProperties") String externProperties, @XmlElement(required=true) @WebParam(name="comment") String comment) throws UnknownDomainException, UnknownModuleException, InvalidVersionException, VersionConverterClassException
	updates the given module More...

void	updateConsent (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKey, @XmlElement(required=true) @WebParam(name="externProperties") String externProperties, @XmlElement(required=true) @WebParam(name="comment") String comment, @XmlElement(required=true) @WebParam(name="scanBase64") String scanBase64, @XmlElement(required=true) @WebParam(name="scanFileType") String scanFileType) throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, InvalidVersionException, VersionConverterClassException, UnknownSignerIdTypeException
	updates the given consent More...

void	addScanToConsent (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKeyDTO, @XmlElement(required=true) @WebParam(name="scanBase64") String scanBase64, @XmlElement(required=true) @WebParam(name="fileType") String fileType) throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
	add the given scan to the given consent More...

void	addSignerIdType (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="signerIdTypeName") String signerIdTypeName) throws UnknownDomainException, DuplicateEntryException
	add a signer id type with the given name to the given domain More...

void	deleteSignerIdType (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="signerIdTypeName") String signerIdTypeName) throws UnknownDomainException, UnknownSignerIdTypeException, ObjectInUseException
	removes the given signer id type from the given domain More...

List< String >	getAllIdsForSignerIdType (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="signerIdTypeName") String signerIdTypeName) throws UnknownDomainException, UnknownSignerIdTypeException
	returns all id for the given signer id type and domain More...

List< String >	getAllConsentedIdsFor (@XmlElement(required=true) @WebParam(name="signerIdTypeName") String signerIdTypeName, @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO policyKeyDTO, @XmlElement(required=true) @WebParam(name="config") CheckConsentConfig config) throws UnknownDomainException, UnknownSignerIdTypeException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
	list all consented ids for the given policy and signerIdType More...

void	validateConsent (@XmlElement(required=true) @WebParam(name="consent") ConsentDTO consentDTO, @XmlElement(required=true) @WebParam(name="allowRevoke") boolean allowRevoke) throws InvalidVersionException, VersionConverterClassException, MissingRequiredObjectException, MandatoryFieldsException, UnknownModuleException, UnknownConsentTemplateException, UnknownDomainException
	validates the given consentDTO checks the given domain, consent template and assures, that the given modules are part of the consent template all mandatory modules need to be either accepted or declined when there's at least one declined mandatory module, no module may be accepted no child module may be accepted if its parent is not when there's at least one accepted module, the two signatures have to be provided More...

void	invalidateConsent (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKeyDTO, @XmlElement(required=true) @WebParam(name="invalidationState") ConsentStatus invalidationState, @XmlElement(required=true) @WebParam(name="comment") String comment, @XmlElement(required=false) @WebParam(name="scanBase64") String scanBase64) throws InvalidVersionException, InvalidConsentStatusException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, UnknownModuleException, InternalException
	invalidates the given consent (stores a new consent with all policies set to invalidationState) More...

void	refuseConsent (@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO ctKeyDTO, @XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO > signerIdDTOs) throws InvalidVersionException, VersionConverterClassException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, InternalException
	stores a "refused" consent - the consent is not declined, the participant didn't want to fill a consent the date of the refused consent is set to the current date More...

void	addSignerIdToConsent (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKeyDTO, @XmlElement(required=true) @WebParam(name="signerId") SignerIdDTO signerIdDTO) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, IllegalArgumentException, UnknownDomainException, InternalException
	adds the given signerId to the given consent More...

void	addSignerIdToSignerId (@XmlElement(required=true) @WebParam(name="domainName") String domainName, @XmlElement(required=true) @WebParam(name="existentSignerId") SignerIdDTO existentSignerIdDTO, @XmlElement(required=true) @WebParam(name="newSignerId") SignerIdDTO newSignerIdDTO) throws UnknownSignerIdTypeException, IllegalArgumentException, InternalException, UnknownDomainException
	adds newSignerId (e.g. More...

Date	getExpirationDate (@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKeyDTO) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, InternalException
	returns the expiration date for the given consent returns a date in the future (aprox. More...

Detailed Description

Definition at line 85 of file GICSService.java.

Member Function Documentation

◆ addConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addConsent ( @XmlElement(required=true) @WebParam(name="consentDTO") ConsentDTO consentDTO ) throws UnknownDomainException, UnknownModuleException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, MissingRequiredObjectException, InvalidFreeTextException, MandatoryFieldsException, UnknownSignerIdTypeException, DuplicateEntryException

stores the given consent
the policies within the modulDTOs are ignored and therefore doesn't need to be set

Parameters

consentDTO

Exceptions

UnknownDomainException
UnknownModuleException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
MissingRequiredObjectException	when there's no given value for a mandatory free text field
InvalidFreeTextException
MandatoryFieldsException	see MandatoryFieldsException
UnknownSignerIdTypeException
DuplicateEntryException

◆ addConsentTemplate()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplate") ConsentTemplateDTO consentTemplateDTO ) throws UnknownDomainException, UnknownModuleException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, FreeTextConverterStringException, InvalidPropertiesException

stores the given consent template
the policies within the modulDTOs are ignored and therefore doesn't need to be set

Parameters

consentTemplateDTO

Exceptions

UnknownDomainException
UnknownModuleException
DuplicateEntryException
VersionConverterClassException
InvalidVersionException
FreeTextConverterStringException	is thrown when the given converter string (in case of FreeTextType.Date) is not a valid string for SimpleDateFormat
InvalidPropertiesException

◆ addDomain()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addDomain ( @XmlElement(required=true) @WebParam(name="domain") DomainDTO domainDTO ) throws DuplicateEntryException, VersionConverterClassException

creates a new domain

Parameters

domainDTO see DomainDTO

Exceptions

DuplicateEntryException	if a domain with that name already exists
VersionConverterClassException

◆ addModule()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addModule ( @XmlElement(required=true) @WebParam(name="module") ModuleDTO moduleDTO ) throws UnknownDomainException, UnknownPolicyException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException

stores the given module

Parameters

policyDTO

Exceptions

UnknownDomainException
UnknownPolicyException
DuplicateEntryException
VersionConverterClassException
InvalidVersionException

◆ addPolicy()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addPolicy ( @XmlElement(required=true) @WebParam(name="policy") PolicyDTO policyDTO ) throws UnknownDomainException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException

stores the given policy

Parameters

policyDTO

Exceptions

UnknownDomainException
DuplicateEntryException
VersionConverterClassException
InvalidVersionException

◆ addScanToConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addScanToConsent	(	@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO	consentKeyDTO,
		@XmlElement(required=true) @WebParam(name="scanBase64") String	scanBase64,
		@XmlElement(required=true) @WebParam(name="fileType") String	fileType
	)		throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

add the given scan to the given consent

Deprecated:: since 2.5.0 - use GICSService.updateConsent instead

Parameters

consentKeyDTO
scanBase64
fileType

Exceptions

UnknownDomainException
UnknownConsentTemplateException
UnknownConsentException
DuplicateEntryException	if there's already a scan attached to that consent
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ addSignerIdToConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addSignerIdToConsent	(	@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO	consentKeyDTO,
		@XmlElement(required=true) @WebParam(name="signerId") SignerIdDTO	signerIdDTO
	)		throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, IllegalArgumentException, UnknownDomainException, InternalException

adds the given signerId to the given consent

Parameters

consentKeyDTO
signerIdDTO

Exceptions

InvalidVersionException
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
InternalException

◆ addSignerIdToSignerId()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addSignerIdToSignerId	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="existentSignerId") SignerIdDTO	existentSignerIdDTO,
		@XmlElement(required=true) @WebParam(name="newSignerId") SignerIdDTO	newSignerIdDTO
	)		throws UnknownSignerIdTypeException, IllegalArgumentException, InternalException, UnknownDomainException

adds newSignerId (e.g.

case number) to one or more virtual persons (which are using the given existentSignerId (e.g. pseudonym))

Parameters

existentSignerIdDTO	existing signerID identifying used by one or more virtual persons
newSignerIdDTO	new signerID to be added to identified virtual persons

Exceptions

UnknownSignerIdTypeException
IllegalArgumentException
InternalException
UnknownDomainException

◆ addSignerIdType()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.addSignerIdType	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="signerIdTypeName") String	signerIdTypeName
	)		throws UnknownDomainException, DuplicateEntryException

add a signer id type with the given name to the given domain

Parameters

domainName
name

Exceptions

UnknownDomainException
DuplicateEntryException

◆ deleteConsentTemplate()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.deleteConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO keyDTO ) throws UnknownDomainException, UnknownConsentTemplateException, ObjectInUseException, VersionConverterClassException, InvalidVersionException

deletes the given consent template (only if it's not in use, i.e.

there's no consent belonging to that consent template)

Parameters

keyDTO

Exceptions

UnknownDomainException
UnknownConsentTemplateException
ObjectInUseException
VersionConverterClassException
InvalidVersionException

◆ deleteDomain()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.deleteDomain ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws ObjectInUseException, UnknownDomainException

deletes the given domain

Parameters

domainName identifier

Exceptions

ObjectInUseException	if there's at least one pseudonym within that domain
UnknownDomainException	if the given domain is not found

◆ deleteModule()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.deleteModule ( @XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO keyDTO ) throws UnknownDomainException, UnknownModuleException, ObjectInUseException, VersionConverterClassException, InvalidVersionException

deletes the given module (only if it's not in use, i.e.

there's no consent template linked to that module)

Parameters

keyDTO

Exceptions

UnknownDomainException
UnknownPolicyException
ObjectInUseException
VersionConverterClassException
InvalidVersionException

◆ deletePolicy()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.deletePolicy ( @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO keyDTO ) throws UnknownDomainException, UnknownPolicyException, ObjectInUseException, VersionConverterClassException, InvalidVersionException

deletes the given policy (only if it's not in use, i.e.

there's no module linked to that policy)

Parameters

keyDTO

Exceptions

UnknownDomainException
UnknownPolicyException
ObjectInUseException
VersionConverterClassException
InvalidVersionException

◆ deleteSignerIdType()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.deleteSignerIdType	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="signerIdTypeName") String	signerIdTypeName
	)		throws UnknownDomainException, UnknownSignerIdTypeException, ObjectInUseException

removes the given signer id type from the given domain

Parameters

domainName
name

Exceptions

UnknownDomainException
UnknownSignerIdTypeException
ObjectInUseException

◆ getAllConsentedIdsFor()

List<String> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllConsentedIdsFor	(	@XmlElement(required=true) @WebParam(name="signerIdTypeName") String	signerIdTypeName,
		@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO	policyKeyDTO,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, UnknownSignerIdTypeException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException

list all consented ids for the given policy and signerIdType

Parameters

signerIdType
policyKey
config

Returns

Exceptions

UnknownDomainException
UnknownSignerIdTypeException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException

◆ getAllConsentsForConsentTemplate()

List<ConsentLightDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllConsentsForConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO ctKeyDTO ) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException

lists all consents for the given consent template

Parameters

ctKeyDTO

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException

◆ getAllConsentsForDomain()

List<ConsentLightDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllConsentsForDomain ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException

lists all consents for the given domain

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException

◆ getAllConsentsForDomainWithoutScan()

List<ConsentLightDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllConsentsForDomainWithoutScan ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException

lists all consents for the given domain which doesn't have a scan attached

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException

◆ getAllConsentsForPerson()

List<ConsentLightDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllConsentsForPerson	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException

lists all consents for the person with the given id

Parameters

domainName
signerIdDTOs	ids of the signer (patient)

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InconsistentStatusException

◆ getAllIdsForSignerIdType()

List<String> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getAllIdsForSignerIdType	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="signerIdTypeName") String	signerIdTypeName
	)		throws UnknownDomainException, UnknownSignerIdTypeException

returns all id for the given signer id type and domain

Parameters

domainName
signerIdType

Returns

Exceptions

UnknownDomainException
UnknownSignerIdTypeException

◆ getConsent()

ConsentDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsent ( @XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO keyDTO ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException, UnknownConsentTemplateException, UnknownSignerIdTypeException, UnknownConsentException

get the complete dto for the given key - thought to be used in addition to the list functions

Parameters

keyDTO

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException
UnknownConsentTemplateException
UnknownConsentException
UnknownSignerIdTypeException

◆ getConsentsForDomainPaginated()

List<ConsentLightDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentsForDomainPaginated	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="firstEntry") int	firstEntry,
		@XmlElement(required=true) @WebParam(name="pageSize") int	pageSize,
		@XmlElement(required=true) @WebParam(name="sortField") ConsentField	sortField,
		@XmlElement(required=true) @WebParam(name="sortIsAscending") boolean	sortIsAscending,
		@XmlElement(required=true) @WebParam(name="filter") HashMapWrapper< ConsentField, Object >	filter
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException

lists consents for the given domain with pagination

Parameters

domainName
pageNumber	starts with 0
pageSize
sortField	see ConsentField
sortIsAscending

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException

◆ getConsentStatusType()

ConsentStatusType org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentStatusType	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO	policyKeyDTO,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given specific version

Parameters

signerIdDTOs	ids of the signer (patient)
policyKeyDTO
config	see CheckConsentConfig

Returns: see ConsentStatusType

Exceptions

UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getConsentStatusTypeFromExcludingToExcluding()

ConsentStatusType org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentStatusTypeFromExcludingToExcluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from < version < to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns: see ConsentStatusType

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getConsentStatusTypeFromExcludingToIncluding()

ConsentStatusType org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentStatusTypeFromExcludingToIncluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from < version <= to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns: see ConsentStatusType

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getConsentStatusTypeFromIncludingToExcluding()

ConsentStatusType org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentStatusTypeFromIncludingToExcluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from <= version < to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns: see ConsentStatusType

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getConsentStatusTypeFromIncludingToIncluding()

ConsentStatusType org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentStatusTypeFromIncludingToIncluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from <= version <= to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns: see ConsentStatusType

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getConsentTemplate()

ConsentTemplateDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getConsentTemplate ( @XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO keyDTO ) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException

returns all attributes of the requested consent template

Parameters

keyDTO

Returns

Exceptions

UnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException

◆ getCurrentConsentForPersonAndCT()

ConsentDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getCurrentConsentForPersonAndCT	(	@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO	ctKeyDTO,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="ignoreVersionNumber") boolean	ignoreVersionNumber
	)		throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException

returns the current consent for the given signerIds
current means: the consent with the highest versionNumber of the associated ConsentTemplate; if there are more then one, the newest (ConsentDate) of them
if "ignoreVersionNumber" is true, then the newest of all consents belonging to the signerIds, regardless of the VersionNumber of the associated ConsentTemplate

Parameters

ctKeyDTO
signerIdDTOs
ignoreVersionNumber

Returns

Exceptions

UnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InconsistentStatusException

◆ getCurrentConsentTemplate()

ConsentTemplateDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getCurrentConsentTemplate	(	@XmlElement(required=true) @WebParam(name="consentTemplateName") String	consentTemplateName,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName
	)		throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException

returns all attributes of the current (highest version) consent template with the given name

Parameters

keyDTO

Returns

Exceptions

UnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException

◆ getDomain()

DomainDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getDomain ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException

returns all information for the given domain

Parameters

domainName identifier

Returns: see DomainDTO

Exceptions

UnknownDomainException if the given domain is not found

◆ getExpirationDate()

Date org.emau.icmvc.ganimed.ttp.cm2.GICSService.getExpirationDate ( @XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO consentKeyDTO ) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, InternalException

returns the expiration date for the given consent
returns a date in the future (aprox.

1000 years), if no expiration date is set

Parameters

consentKey

Returns

Exceptions

InvalidVersionException
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
InternalException

◆ getModule()

ModuleDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getModule ( @XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO keyDTO ) throws UnknownDomainException, UnknownModuleException, VersionConverterClassException, InvalidVersionException

returns all attributes of the requested module

Parameters

keyDTO

Returns

Exceptions

UnknownDomainException
UnknownModuleException
VersionConverterClassException
InvalidVersionException

◆ getPolicy()

PolicyDTO org.emau.icmvc.ganimed.ttp.cm2.GICSService.getPolicy ( @XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO keyDTO ) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException

returns all attributes of the requested policy

Parameters

keyDTO

Returns

Exceptions

UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException

◆ getPolicyStatesForPolicyAndSigner()

List<SignedPolicyDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getPolicyStatesForPolicyAndSigner	(	@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO	policyKeyDTO,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

returns all signed policies for the given policy which are signed by the person with the given id

Parameters

policyKeyDTO
signerIdDTOs	ids of the signer (patient)

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getPolicyStatesForPolicyNameAndSigner()

List<SignedPolicyDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getPolicyStatesForPolicyNameAndSigner	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

returns all signed policies for the given policy name (thus ignoring the version number of the policy) which are signed by the person with the given id

Parameters

domainName
policyName
signerIdDTOs	ids of the signer (patient)

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ getPolicyStatesForSigner()

List<SignedPolicyDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.getPolicyStatesForSigner	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

returns all signed policies which are signed by the person with the given id

Parameters

domainName
signerIdDTOs	ids of the signer (patient)

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ invalidateConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.invalidateConsent	(	@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO	consentKeyDTO,
		@XmlElement(required=true) @WebParam(name="invalidationState") ConsentStatus	invalidationState,
		@XmlElement(required=true) @WebParam(name="comment") String	comment,
		@XmlElement(required=false) @WebParam(name="scanBase64") String	scanBase64
	)		throws InvalidVersionException, InvalidConsentStatusException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, UnknownModuleException, InternalException

invalidates the given consent (stores a new consent with all policies set to invalidationState)

Parameters

consentKey
invalidationState	new state for all policies, need to be of type ConsentStatusType.DECLINED
comment
scanBase64

Exceptions

InvalidVersionException
InvalidConsentStatusException	if invalidationState is not of type ConsentStatusType.DECLINED
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
UnknownModuleException
InternalException

◆ isConsented()

boolean org.emau.icmvc.ganimed.ttp.cm2.GICSService.isConsented	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO	policyKeyDTO,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given specific version

Parameters

signerIdDTOs	ids of the signer (patient)
policyKeyDTO
config	see CheckConsentConfig

Returns

Exceptions

UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ isConsentedFromExcludingToExcluding()

boolean org.emau.icmvc.ganimed.ttp.cm2.GICSService.isConsentedFromExcludingToExcluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from < version < to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ isConsentedFromExcludingToIncluding()

boolean org.emau.icmvc.ganimed.ttp.cm2.GICSService.isConsentedFromExcludingToIncluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from < version <= to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ isConsentedFromIncludingToExcluding()

boolean org.emau.icmvc.ganimed.ttp.cm2.GICSService.isConsentedFromIncludingToExcluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from <= version < to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ isConsentedFromIncludingToIncluding()

boolean org.emau.icmvc.ganimed.ttp.cm2.GICSService.isConsentedFromIncludingToIncluding	(	@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs,
		@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="policyName") String	policyName,
		@XmlElement(required=true) @WebParam(name="versionFrom") String	versionFrom,
		@XmlElement(required=true) @WebParam(name="versionTo") String	versionTo,
		@XmlElement(required=true) @WebParam(name="config") CheckConsentConfig	config
	)		throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException

checks whether there's a signed consent for the given patient and policy in the given version range: from <= version <= to
ignores the config parameter "ignoreVersionNumber"

Parameters

signerIdDTOs	ids of the signer (patient)
domainName
policyName
versionFrom
versionTo
config	see CheckConsentConfig

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ listConsentTemplates()

List<ConsentTemplateDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.listConsentTemplates ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException

lists all consent templates of the given domain

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException

◆ listCurrentConsentTemplates()

List<ConsentTemplateDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.listCurrentConsentTemplates ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException

lists the most recent version of all consent templates of the given domain

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException

◆ listDomains()

List<DomainDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.listDomains ( )

Returns: list of all domains within the database; see DomainDTO

◆ listModules()

List<ModuleDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.listModules ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException

lists all modules of the given domain

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException

◆ listPolicies()

List<PolicyDTO> org.emau.icmvc.ganimed.ttp.cm2.GICSService.listPolicies ( @XmlElement(required=true) @WebParam(name="domainName") String domainName ) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException

lists all policies of the given domain

Parameters

domainName

Returns

Exceptions

UnknownDomainException
VersionConverterClassException
InvalidVersionException

◆ refuseConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.refuseConsent	(	@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO	ctKeyDTO,
		@XmlElement(required=true) @WebParam(name="signerIds") Set< SignerIdDTO >	signerIdDTOs
	)		throws InvalidVersionException, VersionConverterClassException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, InternalException

stores a "refused" consent - the consent is not declined, the participant didn't want to fill a consent
the date of the refused consent is set to the current date

Parameters

ctKeyDTO
signerIdDTOs

Exceptions

InvalidVersionException
VersionConverterClassException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
InternalException

◆ updateConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.updateConsent	(	@XmlElement(required=true) @WebParam(name="consentKey") ConsentKeyDTO	consentKey,
		@XmlElement(required=true) @WebParam(name="externProperties") String	externProperties,
		@XmlElement(required=true) @WebParam(name="comment") String	comment,
		@XmlElement(required=true) @WebParam(name="scanBase64") String	scanBase64,
		@XmlElement(required=true) @WebParam(name="scanFileType") String	scanFileType
	)		throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, InvalidVersionException, VersionConverterClassException, UnknownSignerIdTypeException

updates the given consent

Parameters

consentKey	identifier
externProperties
comment
scanBase64

Exceptions

UnknownDomainException	if the given domain is not found
UnknownConsentTemplateException	if the given consent template is not found
UnknownConsentException	if the given consent is not found
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException

◆ updateConsentTemplate()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.updateConsentTemplate	(	@XmlElement(required=true) @WebParam(name="consentTemplateKey") ConsentTemplateKeyDTO	consentTemplateKey,
		@XmlElement(required=true) @WebParam(name="title") String	title,
		@XmlElement(required=true) @WebParam(name="externProperties") String	externProperties,
		@XmlElement(required=true) @WebParam(name="comment") String	comment,
		@XmlElement(required=true) @WebParam(name="scanBase64") String	scanBase64,
		@XmlElement(required=true) @WebParam(name="scanFileType") String	scanFileType
	)		throws UnknownDomainException, UnknownConsentTemplateException, InvalidVersionException, VersionConverterClassException

updates the given consent template

Parameters

consentTemplateKey	identifier
title
externProperties
comment
scanBase64

Exceptions

UnknownDomainException	if the given domain is not found
UnknownConsentTemplateException	if the given consent template is not found
VersionConverterClassException
InvalidVersionException

◆ updateDomain()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.updateDomain	(	@XmlElement(required=true) @WebParam(name="domainName") String	domainName,
		@XmlElement(required=true) @WebParam(name="label") String	label,
		@XmlElement(required=true) @WebParam(name="logo") String	logo,
		@XmlElement(required=true) @WebParam(name="externProperties") String	externProperties,
		@XmlElement(required=true) @WebParam(name="comment") String	comment
	)		throws UnknownDomainException

updates the given domain

Parameters

domainName	identifier
label
logo
externProperties
comment

Exceptions

UnknownDomainException if the given domain is not found

◆ updateModule()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.updateModule	(	@XmlElement(required=true) @WebParam(name="moduleKey") ModuleKeyDTO	moduleKey,
		@XmlElement(required=true) @WebParam(name="title") String	title,
		@XmlElement(required=true) @WebParam(name="externProperties") String	externProperties,
		@XmlElement(required=true) @WebParam(name="comment") String	comment
	)		throws UnknownDomainException, UnknownModuleException, InvalidVersionException, VersionConverterClassException

updates the given module

Parameters

moduleKey	identifier
label
logo
externProperties
comment

Exceptions

UnknownDomainException	if the given domain is not found
UnknownModuleException	if the given module is not found
VersionConverterClassException
InvalidVersionException

◆ updatePolicy()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.updatePolicy	(	@XmlElement(required=true) @WebParam(name="policyKey") PolicyKeyDTO	policyKey,
		@XmlElement(required=true) @WebParam(name="externProperties") String	externProperties,
		@XmlElement(required=true) @WebParam(name="comment") String	comment
	)		throws UnknownDomainException, UnknownPolicyException, InvalidVersionException, VersionConverterClassException

updates the given policy

Parameters

policyKey	identifier
externProperties
comment

Exceptions

UnknownDomainException	if the given domain is not found
UnknownPolicyException	if the given policy is not found
VersionConverterClassException
InvalidVersionException

◆ validateConsent()

void org.emau.icmvc.ganimed.ttp.cm2.GICSService.validateConsent	(	@XmlElement(required=true) @WebParam(name="consent") ConsentDTO	consentDTO,
		@XmlElement(required=true) @WebParam(name="allowRevoke") boolean	allowRevoke
	)		throws InvalidVersionException, VersionConverterClassException, MissingRequiredObjectException, MandatoryFieldsException, UnknownModuleException, UnknownConsentTemplateException, UnknownDomainException

validates the given consentDTO
checks the given domain, consent template and assures, that the given modules are part of the consent template all mandatory modules need to be either accepted or declined when there's at least one declined mandatory module, no module may be accepted no child module may be accepted if its parent is not when there's at least one accepted module, the two signatures have to be provided

Parameters

consentDTO
allowRevoke

Exceptions

InvalidVersionException
VersionConverterClassException
MissingRequiredObjectException
MandatoryFieldsException
UnknownModuleException
UnknownConsentTemplateException
UnknownDomainException

The documentation for this interface was generated from the following file:

GICSService.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ addConsent()

◆ addConsentTemplate()

◆ addDomain()

◆ addModule()

◆ addPolicy()

◆ addScanToConsent()

◆ addSignerIdToConsent()

◆ addSignerIdToSignerId()

◆ addSignerIdType()

◆ deleteConsentTemplate()

◆ deleteDomain()

◆ deleteModule()

◆ deletePolicy()

◆ deleteSignerIdType()

◆ getAllConsentedIdsFor()

◆ getAllConsentsForConsentTemplate()

◆ getAllConsentsForDomain()

◆ getAllConsentsForDomainWithoutScan()

◆ getAllConsentsForPerson()

◆ getAllIdsForSignerIdType()

◆ getConsent()

◆ getConsentsForDomainPaginated()

◆ getConsentStatusType()

◆ getConsentStatusTypeFromExcludingToExcluding()

◆ getConsentStatusTypeFromExcludingToIncluding()

◆ getConsentStatusTypeFromIncludingToExcluding()

◆ getConsentStatusTypeFromIncludingToIncluding()

◆ getConsentTemplate()

◆ getCurrentConsentForPersonAndCT()

◆ getCurrentConsentTemplate()

◆ getDomain()

◆ getExpirationDate()

◆ getModule()

◆ getPolicy()

◆ getPolicyStatesForPolicyAndSigner()

◆ getPolicyStatesForPolicyNameAndSigner()

◆ getPolicyStatesForSigner()

◆ invalidateConsent()

◆ isConsented()

◆ isConsentedFromExcludingToExcluding()

◆ isConsentedFromExcludingToIncluding()

◆ isConsentedFromIncludingToExcluding()

◆ isConsentedFromIncludingToIncluding()

◆ listConsentTemplates()

◆ listCurrentConsentTemplates()

◆ listDomains()

◆ listModules()

◆ listPolicies()

◆ refuseConsent()

◆ updateConsent()

◆ updateConsentTemplate()

◆ updateDomain()

◆ updateModule()

◆ updatePolicy()

◆ validateConsent()