Package org.emau.icmvc.ganimed.ttp.cm2

Interface GICSServiceWithNotification

public interface GICSServiceWithNotification

An interface for sibling gics-service methods which additionally send notifications via the THS Notification Service.

Author:

moser

Method Summary

Modifier and Type	Method	Description
void	addConsent(String notificationClientID, ConsentDTO consentDTO)	Stores the given consent and sends a notification.
void	addConsentOptOut(String notificationClientID, ConsentTemplateKeyDTO templateKeyDTO, Set<SignerIdDTO> signerIdDTOs)
void	refuseConsent(String notificationClientID, ConsentTemplateKeyDTO ctKeyDTO, Set<SignerIdDTO> signerIdDTOs)	Stores a "refused" consent.
void	setQCForConsent(String notificationClientID, ConsentKeyDTO consentKeyDTO, QCDTO qc)	Updates the QC for the given consent and sends a notification.
void	updateConsentInUse(String notificationClientID, ConsentKeyDTO consentKeyDTO, String externProperties, String comment, ConsentScanDTO scan)	Updates the given consent.

Method Details

setQCForConsent

void setQCForConsent(String notificationClientID,
 ConsentKeyDTO consentKeyDTO,
 QCDTO qc)
              throws InvalidParameterException,
InvalidVersionException,
UnknownConsentException,
UnknownSignerIdTypeException,
UnknownConsentTemplateException,
UnknownDomainException

Updates the QC for the given consent and sends a notification.

Parameters:

notificationClientID - the notification client ID (null or empty to skip sending a notification)

consentKeyDTO - the consent to update the QC for

qc - the new QC

Throws:

InvalidParameterException

InvalidVersionException

UnknownConsentException

UnknownSignerIdTypeException

UnknownConsentTemplateException

UnknownDomainException

InvalidParameterException

See Also:

• GICSService.setQCForConsent(ConsentKeyDTO, QCDTO)

addConsent

void addConsent(String notificationClientID,
 ConsentDTO consentDTO)
         throws UnknownDomainException,
UnknownModuleException,
UnknownConsentTemplateException,
InvalidVersionException,
MissingRequiredObjectException,
InvalidFreeTextException,
MandatoryFieldsException,
UnknownSignerIdTypeException,
DuplicateEntryException,
RequirementsNotFullfilledException,
InvalidParameterException

Stores the given consent and sends a notification. The policies within the modulDTOs are ignored and therefore doesn't need to be set.

Parameters:

notificationClientID - the notification client ID (null or empty to skip sending a notification)

consentDTO - the consent to add

Throws:

UnknownDomainException

UnknownModuleException

UnknownConsentTemplateException

InvalidVersionException

MissingRequiredObjectException - when there's no given value for a mandatory free text field

InvalidFreeTextException

MandatoryFieldsException - see MandatoryFieldsException

UnknownSignerIdTypeException

DuplicateEntryException

RequirementsNotFullfilledException

InvalidParameterException

See Also:

• GICSService.addConsent(ConsentDTO)

refuseConsent

void refuseConsent(String notificationClientID,
 ConsentTemplateKeyDTO ctKeyDTO,
 Set<SignerIdDTO> signerIdDTOs)
            throws InvalidVersionException,
UnknownSignerIdTypeException,
UnknownConsentTemplateException,
UnknownDomainException,
InternalException,
InvalidParameterException

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:

notificationClientID - the notification client ID (null or empty to skip sending a notification)

ctKeyDTO - the consent template key

signerIdDTOs - the signer ID

Throws:

InvalidVersionException

UnknownSignerIdTypeException

UnknownConsentTemplateException

UnknownDomainException

InternalException

InvalidParameterException

See Also:

• GICSService.refuseConsent(ConsentTemplateKeyDTO, Set)

addConsentOptOut

void addConsentOptOut(String notificationClientID,
 ConsentTemplateKeyDTO templateKeyDTO,
 Set<SignerIdDTO> signerIdDTOs)
               throws UnknownSignerIdTypeException,
InvalidParameterException,
UnknownConsentTemplateException,
InvalidVersionException,
RequirementsNotFullfilledException,
UnknownModuleException,
InvalidFreeTextException,
UnknownDomainException,
MissingRequiredObjectException,
MandatoryFieldsException,
DuplicateEntryException

Throws:

UnknownSignerIdTypeException

InvalidParameterException

UnknownConsentTemplateException

InvalidVersionException

RequirementsNotFullfilledException

UnknownModuleException

InvalidFreeTextException

UnknownDomainException

MissingRequiredObjectException

MandatoryFieldsException

DuplicateEntryException

updateConsentInUse

void updateConsentInUse(String notificationClientID,
 ConsentKeyDTO consentKeyDTO,
 String externProperties,
 String comment,
 ConsentScanDTO scan)
                 throws InvalidVersionException,
UnknownDomainException,
UnknownConsentTemplateException,
UnknownSignerIdTypeException,
UnknownConsentException,
InvalidParameterException

Updates the given consent.

Parameters:

notificationClientID - the notification client ID (null or empty to skip sending a notification)

consentKeyDTO - the consent key

externProperties - extern properties

comment - a comment

scan - a scan

Throws:

InvalidVersionException

UnknownDomainException

UnknownConsentTemplateException

UnknownSignerIdTypeException

UnknownConsentException

InvalidParameterException

See Also:

• GICSService.updateConsentInUse(ConsentKeyDTO, String, String, ConsentScanDTO)