public interface GICSService
Modifier and Type | Method and Description |
---|---|
void |
addAlias(java.lang.String domainName,
SignerIdDTO originalSignerId,
SignerIdDTO aliasSignerId)
creates an alias between two signer ids; used for merges
|
void |
addConsent(ConsentDTO consentDTO)
stores the given consent
the policies within the modulDTOs are ignored and therefore doesn't need to be set |
void |
addConsentTemplate(ConsentTemplateDTO consentTemplateDTO,
boolean finaliseRelatedEntities)
stores the given consent template
the policies within the modulDTOs are ignored and therefore doesn't need to be set |
void |
addDomain(DomainDTO domainDTO)
creates a new domain
|
void |
addModule(ModuleDTO moduleDTO,
boolean finaliseRelatedEntities)
stores the given module
|
void |
addPolicy(PolicyDTO policyDTO)
stores the given policy
|
void |
addScanToConsent(ConsentKeyDTO consentKeyDTO,
java.lang.String scanBase64,
java.lang.String fileType,
java.lang.String fileName)
add the given scan to the given consent
|
void |
addSignerIdToConsent(ConsentKeyDTO consentKeyDTO,
SignerIdDTO signerIdDTO)
adds the given signerId to the given consent
|
void |
addSignerIdToSignerId(java.lang.String domainName,
SignerIdDTO existentSignerIdDTO,
SignerIdDTO newSignerIdDTO)
adds newSignerId (e.g. case number) to one or more virtual persons (which are using the given
existentSignerId (e.g. pseudonym))
|
void |
addSignerIdType(java.lang.String domainName,
java.lang.String signerIdTypeName)
add a signer id type with the given name to the given domain
|
long |
countConsentsForDomainWithFilter(java.lang.String domainName,
PaginationConfig config)
count all consents for the given domain with the given filter
|
void |
deactivateAlias(java.lang.String domainName,
SignerIdDTO originalSignerId,
SignerIdDTO aliasSignerId)
deactivates the given alias
|
void |
deleteConsentTemplate(ConsentTemplateKeyDTO keyDTO)
deletes the given consent template (only if it's not in use, i.e. there's no consent
belonging to that consent template)
|
void |
deleteDomain(java.lang.String domainName)
deletes the given domain
|
void |
deleteModule(ModuleKeyDTO keyDTO)
deletes the given module (only if it's not in use, i.e. there's no consent template linked to
that module)
|
void |
deletePolicy(PolicyKeyDTO keyDTO)
deletes the given policy (only if it's not in use, i.e. there's no module linked to that
policy)
|
void |
deleteSignerIdType(java.lang.String domainName,
java.lang.String signerIdTypeName)
removes the given signer id type from the given domain
|
void |
finaliseDomain(java.lang.String domainName)
finalises the given domain
|
void |
finaliseModule(ModuleKeyDTO moduleKeyDTO,
boolean finaliseRelatedEntities)
finalises the given module
|
void |
finalisePolicy(PolicyKeyDTO policyKeyDTO)
finalises the given policy
|
void |
finaliseTemplate(ConsentTemplateKeyDTO consentTemplateKeyDTO,
boolean finaliseRelatedEntities)
finalises the given consent template
|
java.util.List<SignerIdDTO> |
getAliasesForSignerId(java.lang.String domainName,
SignerIdDTO originalSignerId)
returns a list with all signer ids which are connected via an alias to the given signer id
|
java.util.List<java.lang.String> |
getAllConsentedIdsFor(java.lang.String signerIdTypeName,
PolicyKeyDTO policyKeyDTO,
CheckConsentConfig config)
list all consented ids for the given policy and signerIdType
|
java.util.List<ConsentLightDTO> |
getAllConsentsForConsentTemplate(ConsentTemplateKeyDTO ctKeyDTO)
lists all consents for the given consent template
|
java.util.List<ConsentLightDTO> |
getAllConsentsForDomain(java.lang.String domainName)
lists all consents for the given domain
|
java.util.List<ConsentLightDTO> |
getAllConsentsForDomainWithoutScan(java.lang.String domainName)
lists all consents for the given domain which doesn't have a scan attached
|
java.util.List<ConsentLightDTO> |
getAllConsentsForSignerIds(java.lang.String domainName,
java.util.Set<SignerIdDTO> signerIdDTOs,
boolean useAliases)
lists all consents for the person with the given id
|
java.util.List<java.lang.String> |
getAllIdsForSignerIdType(java.lang.String domainName,
java.lang.String signerIdTypeName)
returns all id for the given signer id type and domain
|
ConsentDTO |
getConsent(ConsentKeyDTO keyDTO)
get the complete dto for the given key - thought to be used in addition to the list functions
|
ConsentDateValuesDTO |
getConsentDates(ConsentKeyDTO consentKeyDTO)
returns the important dates for the given consent
|
java.util.List<ConsentLightDTO> |
getConsentsForDomainPaginated(java.lang.String domainName,
PaginationConfig config)
lists all consents for the given domain paginated
|
ConsentStatusType |
getConsentStatusType(java.util.Set<SignerIdDTO> signerIdDTOs,
PolicyKeyDTO policyKeyDTO,
CheckConsentConfig config)
checks whether there's a signed consent for the given patient and policy in the given
specific version
|
ConsentStatusType |
getConsentStatusTypeFromExcludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
ConsentStatusType |
getConsentStatusTypeFromExcludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
ConsentStatusType |
getConsentStatusTypeFromIncludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
ConsentStatusType |
getConsentStatusTypeFromIncludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
ConsentTemplateDTO |
getConsentTemplate(ConsentTemplateKeyDTO keyDTO)
returns all attributes of the requested consent template
|
ConsentDTO |
getCurrentConsentForSignerIdsAndCT(ConsentTemplateKeyDTO ctKeyDTO,
java.util.Set<SignerIdDTO> signerIdDTOs,
boolean ignoreVersionNumber,
boolean useAliases)
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 |
ConsentTemplateDTO |
getCurrentConsentTemplate(java.lang.String consentTemplateName,
java.lang.String domainName)
returns all attributes of the current (highest version) consent template with the given name
|
DomainDTO |
getDomain(java.lang.String domainName)
returns all information for the given domain
|
ModuleDTO |
getModule(ModuleKeyDTO keyDTO)
returns all attributes of the requested module
|
<T extends FhirIdDTO> |
getObjectByFhirID(java.lang.Class<T> clazz,
java.lang.String fhirID)
searches the object with the given fhirID
|
PolicyDTO |
getPolicy(PolicyKeyDTO keyDTO)
returns all attributes of the requested policy
|
java.util.List<SignedPolicyDTO> |
getPolicyStatesForPolicyAndSignerIds(PolicyKeyDTO policyKeyDTO,
java.util.Set<SignerIdDTO> signerIdDTOs,
boolean useAliases)
returns all signed policies for the given policy which are signed by any person with at least
one of the given ids
|
java.util.List<SignedPolicyDTO> |
getPolicyStatesForPolicyNameAndSignerIds(java.lang.String domainName,
java.lang.String policyName,
java.util.Set<SignerIdDTO> signerIdDTOs,
boolean useAliases)
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
|
java.util.List<SignedPolicyDTO> |
getPolicyStatesForSignerIds(java.lang.String domainName,
java.util.Set<SignerIdDTO> signerIdDTOs,
boolean useAliases)
returns all signed policies which are signed by any person with at least one of the given ids
|
java.util.List<QCHistoryDTO> |
getQCHistoryForConsent(ConsentKeyDTO consentKeyDTO)
returns a list with all qc entries for the given consent
|
SignerIdTypeDTO |
getSignerIdType(java.lang.String domainName,
java.lang.String signerIdTypeName)
returns all information for the given signerIdType
|
boolean |
isConsented(java.util.Set<SignerIdDTO> signerIdDTOs,
PolicyKeyDTO policyKeyDTO,
CheckConsentConfig config)
checks whether there's a signed consent for the given patient and policy in the given
specific version
|
boolean |
isConsentedFromExcludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
boolean |
isConsentedFromExcludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
boolean |
isConsentedFromIncludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
boolean |
isConsentedFromIncludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs,
java.lang.String domainName,
java.lang.String policyName,
java.lang.String versionFrom,
java.lang.String versionTo,
CheckConsentConfig config)
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" |
java.util.List<ConsentTemplateDTO> |
listConsentTemplates(java.lang.String domainName,
boolean onlyFinal)
lists all consent templates of the given domain
|
java.util.List<ConsentTemplateDTO> |
listCurrentConsentTemplates(java.lang.String domainName)
lists the most recent version of all consent templates of the given domain
|
java.util.List<DomainDTO> |
listDomains() |
java.util.List<ModuleDTO> |
listModules(java.lang.String domainName,
boolean onlyFinal)
lists all modules of the given domain
|
java.util.List<PolicyDTO> |
listPolicies(java.lang.String domainName,
boolean onlyFinal)
lists all policies of the given domain
|
java.util.List<SignerIdTypeDTO> |
listSignerIdTypes(java.lang.String domainName)
list all signerIDTypes for the given domain
|
void |
refuseConsent(ConsentTemplateKeyDTO ctKeyDTO,
java.util.Set<SignerIdDTO> signerIdDTOs)
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 |
void |
removeScanFromConsent(ConsentKeyDTO consentKeyDTO,
java.lang.String fhirId)
Remove a scan from the given consent
|
void |
setQCForConsent(ConsentKeyDTO consentKeyDTO,
QCDTO qc)
updates the qc for the given consent
|
void |
updateConsentInUse(ConsentKeyDTO consentKeyDTO,
java.lang.String externProperties,
java.lang.String comment,
ConsentScanDTO scan)
updates the given consent
|
void |
updateConsentTemplate(ConsentTemplateDTO consentTemplateDTO,
boolean finaliseRelatedEntities)
updates the given consent template
|
void |
updateConsentTemplateInUse(ConsentTemplateDTO consentTemplateDTO)
updates label, title, comment, externProperties, scanBase64, scanFileType,
assignedModule.comment, assignedModule.externProperties, freeTextDef.comment
|
void |
updateDomain(DomainDTO domainDTO)
updates the given domain
|
void |
updateDomainInUse(java.lang.String domainName,
java.lang.String label,
java.lang.String logo,
java.lang.String externProperties,
java.lang.String comment)
updates the given domain with the given values
|
void |
updateModule(ModuleDTO moduleDTO,
boolean finaliseRelatedEntities)
updates the given module
|
void |
updateModuleInUse(ModuleKeyDTO moduleKeyDTO,
java.lang.String label,
java.lang.String shortText,
java.lang.String externProperties,
java.lang.String comment)
updates the given module with the given values
|
void |
updatePolicy(PolicyDTO policyDTO)
updates the given policy
|
void |
updatePolicyInUse(PolicyKeyDTO policyKeyDTO,
java.lang.String label,
java.lang.String externProperties,
java.lang.String comment)
updates the given policy with the given values
|
void |
updateSignerIdType(java.lang.String domainName,
java.lang.String signerIdTypeName,
java.lang.String label,
java.lang.String comment)
updates the given signerIdType with the given values
|
void |
validateConsent(ConsentDTO consentDTO,
boolean allowRevoke)
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 |
void addConsent(ConsentDTO consentDTO) throws UnknownDomainException, UnknownModuleException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, MissingRequiredObjectException, InvalidFreeTextException, MandatoryFieldsException, UnknownSignerIdTypeException, DuplicateEntryException, InternalException, RequirementsNotFullfilledException, InvalidParameterException
consentDTO
- UnknownDomainException
UnknownModuleException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
MissingRequiredObjectException
- when there's no given value for a mandatory free text fieldInvalidFreeTextException
MandatoryFieldsException
- see MandatoryFieldsException
UnknownSignerIdTypeException
DuplicateEntryException
RequirementsNotFullfilledException
InvalidParameterException
InternalException
boolean isConsented(java.util.Set<SignerIdDTO> signerIdDTOs, PolicyKeyDTO policyKeyDTO, CheckConsentConfig config) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)policyKeyDTO
- config
- see CheckConsentConfig
UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
boolean isConsentedFromIncludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
boolean isConsentedFromExcludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
boolean isConsentedFromIncludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
boolean isConsentedFromExcludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
ConsentStatusType getConsentStatusType(java.util.Set<SignerIdDTO> signerIdDTOs, PolicyKeyDTO policyKeyDTO, CheckConsentConfig config) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)policyKeyDTO
- config
- see CheckConsentConfig
ConsentStatusType
UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
ConsentStatusType getConsentStatusTypeFromIncludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
ConsentStatusType
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
ConsentStatusType getConsentStatusTypeFromExcludingToIncluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
ConsentStatusType
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
ConsentStatusType getConsentStatusTypeFromIncludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
ConsentStatusType
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
ConsentStatusType getConsentStatusTypeFromExcludingToExcluding(java.util.Set<SignerIdDTO> signerIdDTOs, java.lang.String domainName, java.lang.String policyName, java.lang.String versionFrom, java.lang.String versionTo, CheckConsentConfig config) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
signerIdDTOs
- ids of the signer (patient)domainName
- policyName
- versionFrom
- versionTo
- config
- see CheckConsentConfig
ConsentStatusType
UnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
java.util.List<ConsentTemplateDTO> listConsentTemplates(java.lang.String domainName, boolean onlyFinal) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
domainName
- onlyFinal
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
java.util.List<ConsentTemplateDTO> listCurrentConsentTemplates(java.lang.String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
domainName
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
void addConsentTemplate(ConsentTemplateDTO consentTemplateDTO, boolean finaliseRelatedEntities) throws UnknownDomainException, UnknownModuleException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, FreeTextConverterStringException, InvalidPropertiesException, RequirementsNotFullfilledException, InvalidParameterException
consentTemplateDTO
- 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
RequirementsNotFullfilledException
InvalidParameterException
void deleteConsentTemplate(ConsentTemplateKeyDTO keyDTO) throws UnknownDomainException, UnknownConsentTemplateException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownConsentTemplateException
ObjectInUseException
VersionConverterClassException
InvalidVersionException
java.util.List<ModuleDTO> listModules(java.lang.String domainName, boolean onlyFinal) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
domainName
- onlyFinal
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
void addModule(ModuleDTO moduleDTO, boolean finaliseRelatedEntities) throws UnknownDomainException, UnknownPolicyException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, RequirementsNotFullfilledException
void deleteModule(ModuleKeyDTO keyDTO) throws UnknownDomainException, UnknownModuleException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
ModuleDTO getModule(ModuleKeyDTO keyDTO) throws UnknownDomainException, UnknownModuleException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownModuleException
VersionConverterClassException
InvalidVersionException
java.util.List<PolicyDTO> listPolicies(java.lang.String domainName, boolean onlyFinal) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException
domainName
- onlyFinal
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
void addPolicy(PolicyDTO policyDTO) throws UnknownDomainException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, RequirementsNotFullfilledException
policyDTO
- UnknownDomainException
DuplicateEntryException
VersionConverterClassException
InvalidVersionException
RequirementsNotFullfilledException
void deletePolicy(PolicyKeyDTO keyDTO) throws UnknownDomainException, UnknownPolicyException, ObjectInUseException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownPolicyException
ObjectInUseException
VersionConverterClassException
InvalidVersionException
PolicyDTO getPolicy(PolicyKeyDTO keyDTO) throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
ConsentTemplateDTO getConsentTemplate(ConsentTemplateKeyDTO keyDTO) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
ConsentTemplateDTO getCurrentConsentTemplate(java.lang.String consentTemplateName, java.lang.String domainName) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException
keyDTO
- UnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
java.util.List<SignedPolicyDTO> getPolicyStatesForSignerIds(java.lang.String domainName, java.util.Set<SignerIdDTO> signerIdDTOs, boolean useAliases) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
domainName
- signerIdDTOs
- ids of the signer (patient)useAliases
- check aliases for related signerIdsUnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
java.util.List<SignedPolicyDTO> getPolicyStatesForPolicyAndSignerIds(PolicyKeyDTO policyKeyDTO, java.util.Set<SignerIdDTO> signerIdDTOs, boolean useAliases) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
policyKeyDTO
- signerIdDTOs
- ids of the signer (patient)useAliases
- check aliases for related signerIdsUnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
java.util.List<SignedPolicyDTO> getPolicyStatesForPolicyNameAndSignerIds(java.lang.String domainName, java.lang.String policyName, java.util.Set<SignerIdDTO> signerIdDTOs, boolean useAliases) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException
domainName
- policyName
- signerIdDTOs
- ids of the signer (patient)useAliases
- check aliases for related signerIdsUnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
java.util.List<ConsentLightDTO> getAllConsentsForSignerIds(java.lang.String domainName, java.util.Set<SignerIdDTO> signerIdDTOs, boolean useAliases) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException
domainName
- signerIdDTOs
- ids of the signer (patient)useAliases
- check aliases for related signerIdsUnknownDomainException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InconsistentStatusException
ConsentDTO getCurrentConsentForSignerIdsAndCT(ConsentTemplateKeyDTO ctKeyDTO, java.util.Set<SignerIdDTO> signerIdDTOs, boolean ignoreVersionNumber, boolean useAliases) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InconsistentStatusException
ctKeyDTO
- signerIdDTOs
- ignoreVersionNumber
- useAliases
- check aliases for related signerIdsUnknownDomainException
UnknownConsentTemplateException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InconsistentStatusException
java.util.List<ConsentLightDTO> getAllConsentsForConsentTemplate(ConsentTemplateKeyDTO ctKeyDTO) throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
ctKeyDTO
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException
UnknownConsentTemplateException
java.util.List<ConsentLightDTO> getAllConsentsForDomain(java.lang.String domainName) throws InconsistentStatusException, InvalidParameterException, InvalidVersionException, UnknownDomainException, VersionConverterClassException
domainName
- InconsistentStatusException
InvalidParameterException
InvalidVersionException
UnknownDomainException
VersionConverterClassException
java.util.List<ConsentLightDTO> getConsentsForDomainPaginated(java.lang.String domainName, PaginationConfig config) throws InconsistentStatusException, InvalidParameterException, InvalidVersionException, UnknownDomainException, VersionConverterClassException
domainName
- config
- see PaginationConfig
InconsistentStatusException
InvalidParameterException
InvalidVersionException
UnknownDomainException
VersionConverterClassException
long countConsentsForDomainWithFilter(java.lang.String domainName, PaginationConfig config) throws InvalidParameterException, InvalidVersionException, UnknownDomainException
domainName
- config
- see PaginationConfig
, only PaginationConfig.filter
,
PaginationConfig#filterFieldsAreTreadetAsConjuction
and
PaginationConfig.filterIsCaseSensitive
are
usedInvalidParameterException
InvalidVersionException
UnknownDomainException
java.util.List<ConsentLightDTO> getAllConsentsForDomainWithoutScan(java.lang.String domainName) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
domainName
- UnknownDomainException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException
ConsentDTO getConsent(ConsentKeyDTO keyDTO) throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException, UnknownConsentTemplateException, UnknownSignerIdTypeException, UnknownConsentException
void addDomain(DomainDTO domainDTO) throws DuplicateEntryException, VersionConverterClassException
domainDTO
- see DomainDTO
DuplicateEntryException
- if a domain with that name already existsVersionConverterClassException
void deleteDomain(java.lang.String domainName) throws ObjectInUseException, UnknownDomainException
domainName
- identifierObjectInUseException
- if there's at least one pseudonym within that domainUnknownDomainException
- if the given domain is not foundDomainDTO getDomain(java.lang.String domainName) throws UnknownDomainException
domainName
- identifierDomainDTO
UnknownDomainException
- if the given domain is not foundjava.util.List<DomainDTO> listDomains()
DomainDTO
void updateDomain(DomainDTO domainDTO) throws ObjectInUseException, UnknownDomainException
domainDTO
- ObjectInUseException
UnknownDomainException
void updateDomainInUse(java.lang.String domainName, java.lang.String label, java.lang.String logo, java.lang.String externProperties, java.lang.String comment) throws UnknownDomainException
domainName
- label
- logo
- externProperties
- comment
- UnknownDomainException
void updatePolicy(PolicyDTO policyDTO) throws InvalidVersionException, ObjectInUseException, UnknownDomainException, UnknownPolicyException
policyDTO
- InvalidVersionException
ObjectInUseException
UnknownDomainException
UnknownPolicyException
void updatePolicyInUse(PolicyKeyDTO policyKeyDTO, java.lang.String label, java.lang.String externProperties, java.lang.String comment) throws InvalidVersionException, UnknownDomainException, UnknownPolicyException
policyKeyDTO
- label
- externProperties
- comment
- InvalidVersionException
UnknownDomainException
UnknownPolicyException
void updateModule(ModuleDTO moduleDTO, boolean finaliseRelatedEntities) throws DuplicateEntryException, InvalidVersionException, ObjectInUseException, RequirementsNotFullfilledException, UnknownDomainException, UnknownModuleException, UnknownPolicyException
void updateModuleInUse(ModuleKeyDTO moduleKeyDTO, java.lang.String label, java.lang.String shortText, java.lang.String externProperties, java.lang.String comment) throws InvalidVersionException, UnknownDomainException, UnknownModuleException, VersionConverterClassException
moduleKeyDTO
- label
- comment
- title
- externProperties
- InvalidVersionException
UnknownDomainException
UnknownModuleException
VersionConverterClassException
void updateConsentTemplate(ConsentTemplateDTO consentTemplateDTO, boolean finaliseRelatedEntities) throws DuplicateEntryException, FreeTextConverterStringException, InvalidFreeTextException, InvalidPropertiesException, InvalidVersionException, ObjectInUseException, RequirementsNotFullfilledException, UnknownConsentTemplateException, UnknownDomainException, UnknownModuleException, InvalidParameterException
consentTemplateDTO
- DuplicateEntryException
FreeTextConverterStringException
InvalidFreeTextException
InvalidPropertiesException
InvalidVersionException
ObjectInUseException
RequirementsNotFullfilledException
UnknownConsentTemplateException
UnknownDomainException
UnknownModuleException
InvalidParameterException
void updateConsentTemplateInUse(ConsentTemplateDTO consentTemplateDTO) throws InvalidFreeTextException, InvalidVersionException, UnknownConsentTemplateException, UnknownDomainException, UnknownModuleException, InvalidParameterException
consentTemplateDTO
- InvalidFreeTextException
InvalidVersionException
UnknownConsentTemplateException
UnknownDomainException
UnknownModuleException
InvalidParameterException
void updateConsentInUse(ConsentKeyDTO consentKeyDTO, java.lang.String externProperties, java.lang.String comment, ConsentScanDTO scan) throws InvalidVersionException, UnknownDomainException, UnknownConsentTemplateException, UnknownSignerIdTypeException, UnknownConsentException, VersionConverterClassException, InvalidParameterException
keyDTO
- externProperties
- comment
- scan
- InvalidVersionException
UnknownDomainException
UnknownConsentTemplateException
UnknownSignerIdTypeException
UnknownConsentException
VersionConverterClassException
InvalidParameterException
void finaliseDomain(java.lang.String domainName) throws UnknownDomainException
domainName
- finaliseRelatedEntities
- UnknownDomainException
void finalisePolicy(PolicyKeyDTO policyKeyDTO) throws InvalidVersionException, UnknownDomainException, UnknownPolicyException
policyKeyDTO
- finaliseRelatedEntities
- InvalidVersionException
UnknownDomainException
UnknownPolicyException
void finaliseModule(ModuleKeyDTO moduleKeyDTO, boolean finaliseRelatedEntities) throws InvalidVersionException, RequirementsNotFullfilledException, UnknownDomainException, UnknownModuleException
moduleKeyDTO
- finaliseRelatedEntities
- InvalidVersionException
RequirementsNotFullfilledException
UnknownDomainException
UnknownModuleException
void finaliseTemplate(ConsentTemplateKeyDTO consentTemplateKeyDTO, boolean finaliseRelatedEntities) throws InvalidVersionException, RequirementsNotFullfilledException, UnknownConsentTemplateException, UnknownDomainException
consentTemplateKeyDTO
- finaliseRelatedEntities
- InvalidVersionException
RequirementsNotFullfilledException
UnknownConsentTemplateException
UnknownDomainException
void addScanToConsent(ConsentKeyDTO consentKeyDTO, java.lang.String scanBase64, java.lang.String fileType, java.lang.String fileName) throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InvalidParameterException
consentKeyDTO
- scanBase64
- fileType
- fileName
- UnknownDomainException
UnknownConsentTemplateException
UnknownConsentException
DuplicateEntryException
- if there's already a scan attached to that consentVersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InvalidParameterException
void removeScanFromConsent(ConsentKeyDTO consentKeyDTO, java.lang.String fhirId) throws UnknownDomainException, UnknownConsentTemplateException, UnknownConsentException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException, UnknownSignerIdTypeException, InvalidParameterException
consentKeyDTO
- scanId
- UnknownDomainException
UnknownConsentTemplateException
UnknownConsentException
DuplicateEntryException
VersionConverterClassException
InvalidVersionException
UnknownSignerIdTypeException
InvalidParameterException
void addSignerIdType(java.lang.String domainName, java.lang.String signerIdTypeName) throws UnknownDomainException, DuplicateEntryException
domainName
- signerIdTypeName
- identifierUnknownDomainException
- if the given domain is not foundDuplicateEntryException
- if the signerIdType already existsSignerIdTypeDTO getSignerIdType(java.lang.String domainName, java.lang.String signerIdTypeName) throws UnknownDomainException, UnknownSignerIdTypeException
domainName
- domain to which the signerIdType belongs tosignerIdTypeName
- identifierSignerIdTypeDTO
UnknownDomainException
- if the given domain is not foundUnknownSignerIdTypeException
- if the given signerIdType is not foundvoid updateSignerIdType(java.lang.String domainName, java.lang.String signerIdTypeName, java.lang.String label, java.lang.String comment) throws UnknownDomainException, UnknownSignerIdTypeException
domainName
- domain to which the signerIdType belongs tosignerIdTypeName
- identifierlabel
- comment
- UnknownDomainException
- if the given domain is not foundUnknownSignerIdTypeException
- if the given signerIdType is not foundjava.util.List<SignerIdTypeDTO> listSignerIdTypes(java.lang.String domainName) throws UnknownDomainException
domainName
- domain to which the signerIdTypes belongs toSignerIdTypeDTO
UnknownDomainException
- if the given domain is not foundvoid deleteSignerIdType(java.lang.String domainName, java.lang.String signerIdTypeName) throws UnknownDomainException, UnknownSignerIdTypeException, ObjectInUseException
domainName
- domain to which the signerIdType belongs tosignerIdTypeName
- identifierUnknownDomainException
UnknownSignerIdTypeException
ObjectInUseException
java.util.List<java.lang.String> getAllIdsForSignerIdType(java.lang.String domainName, java.lang.String signerIdTypeName) throws UnknownDomainException, UnknownSignerIdTypeException
domainName
- domain to which the signerIdType belongs tosignerIdTypeName
- identifier of the signerIdTypeUnknownDomainException
UnknownSignerIdTypeException
java.util.List<java.lang.String> getAllConsentedIdsFor(java.lang.String signerIdTypeName, PolicyKeyDTO policyKeyDTO, CheckConsentConfig config) throws UnknownDomainException, UnknownSignerIdTypeException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException
signerIdType
- policyKey
- config
- UnknownDomainException
UnknownSignerIdTypeException
UnknownPolicyException
VersionConverterClassException
InvalidVersionException
InconsistentStatusException
void validateConsent(ConsentDTO consentDTO, boolean allowRevoke) throws InvalidVersionException, VersionConverterClassException, MissingRequiredObjectException, MandatoryFieldsException, UnknownModuleException, UnknownConsentTemplateException, UnknownDomainException
consentDTO
- allowRevoke
- InvalidVersionException
VersionConverterClassException
MissingRequiredObjectException
MandatoryFieldsException
UnknownModuleException
UnknownConsentTemplateException
UnknownDomainException
void refuseConsent(ConsentTemplateKeyDTO ctKeyDTO, java.util.Set<SignerIdDTO> signerIdDTOs) throws InvalidVersionException, VersionConverterClassException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException, InternalException, InvalidParameterException
ctKeyDTO
- signerIdDTOs
- InvalidVersionException
VersionConverterClassException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
InternalException
InvalidParameterException
void addSignerIdToConsent(ConsentKeyDTO consentKeyDTO, SignerIdDTO signerIdDTO) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, java.lang.IllegalArgumentException, UnknownDomainException, InternalException, InvalidParameterException
consentKeyDTO
- signerIdDTO
- InvalidVersionException
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
InternalException
InvalidParameterException
java.lang.IllegalArgumentException
void addSignerIdToSignerId(java.lang.String domainName, SignerIdDTO existentSignerIdDTO, SignerIdDTO newSignerIdDTO) throws UnknownSignerIdTypeException, java.lang.IllegalArgumentException, InternalException, UnknownDomainException, InvalidParameterException
existentSignerIdDTO
- existing signerID identifying used by one or more virtual personsnewSignerIdDTO
- new signerID to be added to identified virtual personsUnknownSignerIdTypeException
java.lang.IllegalArgumentException
InternalException
UnknownDomainException
InvalidParameterException
ConsentDateValuesDTO getConsentDates(ConsentKeyDTO consentKeyDTO) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException
consentKey
- InvalidVersionException
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
void addAlias(java.lang.String domainName, SignerIdDTO originalSignerId, SignerIdDTO aliasSignerId) throws InvalidParameterException, UnknownDomainException, UnknownSignerIdException, UnknownSignerIdTypeException
domainName
- originalSignerId
- aliasSignerId
- InvalidParameterException
UnknownDomainException
UnknownSignerIdException
- if the originalSignerId doesn't exists within the given domainUnknownSignerIdTypeException
void deactivateAlias(java.lang.String domainName, SignerIdDTO originalSignerId, SignerIdDTO aliasSignerId) throws InvalidParameterException, UnknownAliasException, UnknownDomainException, UnknownSignerIdException, UnknownSignerIdTypeException
domainName
- originalSignerId
- aliasSignerId
- InvalidParameterException
UnknownAliasException
UnknownDomainException
UnknownSignerIdException
UnknownSignerIdTypeException
java.util.List<SignerIdDTO> getAliasesForSignerId(java.lang.String domainName, SignerIdDTO originalSignerId) throws InvalidParameterException, UnknownDomainException, UnknownSignerIdException, UnknownSignerIdTypeException
domainName
- originalSignerId
- InvalidParameterException
UnknownDomainException
UnknownSignerIdException
UnknownSignerIdTypeException
void setQCForConsent(ConsentKeyDTO consentKeyDTO, QCDTO qc) throws InvalidParameterException, InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException
java.util.List<QCHistoryDTO> getQCHistoryForConsent(ConsentKeyDTO consentKeyDTO) throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException, UnknownConsentTemplateException, UnknownDomainException
consentKeyDTO
- InvalidVersionException
VersionConverterClassException
UnknownConsentException
UnknownSignerIdTypeException
UnknownConsentTemplateException
UnknownDomainException
<T extends FhirIdDTO> T getObjectByFhirID(java.lang.Class<T> clazz, java.lang.String fhirID) throws UnknownFhirIdObjectException, UnknownIDException
clazz
- fhirID
- UnknownFhirIdObjectException
- if that object is not known (DAO.getObjectByFhirID)UnknownIDException
- if that object is not found