GICSService.java

package org.emau.icmvc.ganimed.ttp.cm2;

/*
 * ###license-information-start###
 * gICS - a Generic Informed Consent Service
 * __
 * Copyright (C) 2014 - 2018 The MOSAIC Project - Institut fuer Community
 *                                                      Medicine of the University Medicine Greifswald -
 *                                                      mosaic-projekt@uni-greifswald.de
 * 
 *                                                      concept and implementation
 *                                                      l.geidel
 *                                                      web client
 *                                                      a.blumentritt, m.bialke
 * 
 *                                                      Selected functionalities of gICS were developed as part of the MAGIC Project (funded by the DFG HO 1937/5-1).
 * 
 *                                                      please cite our publications
 *                                                      http://dx.doi.org/10.3414/ME14-01-0133
 *                                                      http://dx.doi.org/10.1186/s12967-015-0545-6
 *                                                      http://dx.doi.org/10.3205/17gmds146
 * __
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * ###license-information-end###
 */

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.Set;

import javax.jws.WebParam;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlElement;

import org.emau.icmvc.ganimed.ttp.cm2.config.CheckConsentConfig;
import org.emau.icmvc.ganimed.ttp.cm2.config.ConsentField;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ConsentDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ConsentKeyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ConsentLightDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ConsentTemplateDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ConsentTemplateKeyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.DomainDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.HashMapWrapper;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ModuleDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.ModuleKeyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.PolicyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.PolicyKeyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.SignedPolicyDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.SignerIdDTO;
import org.emau.icmvc.ganimed.ttp.cm2.dto.enums.ConsentStatus;
import org.emau.icmvc.ganimed.ttp.cm2.dto.enums.ConsentStatusType;
import org.emau.icmvc.ganimed.ttp.cm2.dto.enums.FreeTextType;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.DuplicateEntryException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.FreeTextConverterStringException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InconsistentStatusException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InternalException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InvalidConsentStatusException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InvalidFreeTextException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InvalidPropertiesException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.InvalidVersionException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.MandatoryFieldsException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.MissingRequiredObjectException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.ObjectInUseException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownConsentException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownConsentTemplateException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownDomainException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownModuleException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownPolicyException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.UnknownSignerIdTypeException;
import org.emau.icmvc.ganimed.ttp.cm2.exceptions.VersionConverterClassException;

@WebService
public interface GICSService {

        public void addConsent(@XmlElement(required = true) @WebParam(name = "consentDTO") ConsentDTO consentDTO) throws UnknownDomainException,
                        UnknownModuleException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException,
                        MissingRequiredObjectException, InvalidFreeTextException, MandatoryFieldsException, UnknownSignerIdTypeException, DuplicateEntryException;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public List<ConsentTemplateDTO> listConsentTemplates(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException;

        public List<ConsentTemplateDTO> listCurrentConsentTemplates(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException;

        public void addConsentTemplate(@XmlElement(required = true) @WebParam(name = "consentTemplate") ConsentTemplateDTO consentTemplateDTO)
                        throws UnknownDomainException, UnknownModuleException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException,
                        FreeTextConverterStringException, InvalidPropertiesException;

        public void deleteConsentTemplate(@XmlElement(required = true) @WebParam(name = "consentTemplateKey") ConsentTemplateKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownConsentTemplateException, ObjectInUseException, VersionConverterClassException,
                        InvalidVersionException;

        public List<ModuleDTO> listModules(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException;

        public void addModule(@XmlElement(required = true) @WebParam(name = "module") ModuleDTO moduleDTO)
                        throws UnknownDomainException, UnknownPolicyException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException;

        public void deleteModule(@XmlElement(required = true) @WebParam(name = "moduleKey") ModuleKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownModuleException, ObjectInUseException, VersionConverterClassException, InvalidVersionException;

        public ModuleDTO getModule(@XmlElement(required = true) @WebParam(name = "moduleKey") ModuleKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownModuleException, VersionConverterClassException, InvalidVersionException;

        public List<PolicyDTO> listPolicies(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException;

        public void addPolicy(@XmlElement(required = true) @WebParam(name = "policy") PolicyDTO policyDTO)
                        throws UnknownDomainException, DuplicateEntryException, VersionConverterClassException, InvalidVersionException;

        public void deletePolicy(@XmlElement(required = true) @WebParam(name = "policyKey") PolicyKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownPolicyException, ObjectInUseException, VersionConverterClassException, InvalidVersionException;

        public PolicyDTO getPolicy(@XmlElement(required = true) @WebParam(name = "policyKey") PolicyKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownPolicyException, VersionConverterClassException, InvalidVersionException;

        public ConsentTemplateDTO getConsentTemplate(@XmlElement(required = true) @WebParam(name = "consentTemplateKey") ConsentTemplateKeyDTO keyDTO)
                        throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException;

        public ConsentTemplateDTO getCurrentConsentTemplate(
                        @XmlElement(required = true) @WebParam(name = "consentTemplateName") String consentTemplateName,
                        @XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public List<ConsentLightDTO> getAllConsentsForConsentTemplate(
                        @XmlElement(required = true) @WebParam(name = "consentTemplateKey") ConsentTemplateKeyDTO ctKeyDTO) throws UnknownDomainException,
                        UnknownConsentTemplateException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException;

        public List<ConsentLightDTO> getAllConsentsForDomain(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException;

        public List<ConsentLightDTO> getAllConsentsForDomainWithoutScan(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException;

        public 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;

        public ConsentDTO getConsent(@XmlElement(required = true) @WebParam(name = "consentKey") ConsentKeyDTO keyDTO)
                        throws UnknownDomainException, VersionConverterClassException, InvalidVersionException, InconsistentStatusException,
                        UnknownConsentTemplateException, UnknownSignerIdTypeException, UnknownConsentException;

        public void addDomain(@XmlElement(required = true) @WebParam(name = "domain") DomainDTO domainDTO)
                        throws DuplicateEntryException, VersionConverterClassException;

        public void deleteDomain(@XmlElement(required = true) @WebParam(name = "domainName") String domainName)
                        throws ObjectInUseException, UnknownDomainException;

        public DomainDTO getDomain(@XmlElement(required = true) @WebParam(name = "domainName") String domainName) throws UnknownDomainException;

        public List<DomainDTO> listDomains();

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        @Deprecated
        public 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;

        public void addSignerIdType(@XmlElement(required = true) @WebParam(name = "domainName") String domainName,
                        @XmlElement(required = true) @WebParam(name = "signerIdTypeName") String signerIdTypeName)
                        throws UnknownDomainException, DuplicateEntryException;

        public void deleteSignerIdType(@XmlElement(required = true) @WebParam(name = "domainName") String domainName,
                        @XmlElement(required = true) @WebParam(name = "signerIdTypeName") String signerIdTypeName)
                        throws UnknownDomainException, UnknownSignerIdTypeException, ObjectInUseException;

        public List<String> getAllIdsForSignerIdType(@XmlElement(required = true) @WebParam(name = "domainName") String domainName,
                        @XmlElement(required = true) @WebParam(name = "signerIdTypeName") String signerIdTypeName)
                        throws UnknownDomainException, UnknownSignerIdTypeException;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public 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;

        public Date getExpirationDate(@XmlElement(required = true) @WebParam(name = "consentKey") ConsentKeyDTO consentKeyDTO)
                        throws InvalidVersionException, VersionConverterClassException, UnknownConsentException, UnknownSignerIdTypeException,
                        UnknownConsentTemplateException, UnknownDomainException, InternalException;
}