org.emau.icmvc.ttp.epix.service

Interface EPIXService

public interface EPIXService

Author:

Christian Schack, geidell

Method Summary

Modifier and Type	Method and Description
IdentityOutDTO	addContact(long identityId, ContactInDTO contactDTO)
void	addLocalIdentifierToIdentifier(java.lang.String domainName, IdentifierDTO identifier, java.util.List<IdentifierDTO> localIds)
void	addLocalIdentifierToMPI(java.lang.String domainName, java.lang.String mpiId, java.util.List<IdentifierDTO> localIds)
ResponseEntryDTO	addPerson(java.lang.String domainName, IdentityInDTO identity, java.lang.String sourceName, java.lang.String comment)
void	assignIdentity(long possibleMatchId, long winningIdentityId, java.lang.String comment)
long	countPossibleMatchesForDomainFiltered(java.lang.String domainName, java.util.Map<IdentityField,java.lang.String> filter, boolean filterIsCaseSensitive)
long	countPossibleMatchesForDomainFilteredByDefault(java.lang.String domainName, java.lang.String filter, boolean filterIsCaseSensitive, java.lang.String birthDateFormat, java.lang.String creationTimeFormat)
void	deactivateIdentity(long identityId)
void	deactivatePerson(java.lang.String domainName, java.lang.String mpiId)
void	deleteIdentity(long identityId)
void	deletePerson(java.lang.String domainName, java.lang.String mpiId)
PossibleMatchDTO	externalPossibleMatchForIdentity(java.lang.String domainName, long identityId, long aliasIdentityId)
PossibleMatchDTO	externalPossibleMatchForPerson(java.lang.String domainName, java.lang.String mpiId, java.lang.String aliasMpiId)
java.util.List<IdentifierDTO>	getAllIdentifierForIdentifier(java.lang.String domainName, IdentifierDTO identifier)
java.util.List<IdentifierDTO>	getAllIdentifierForMPI(java.lang.String domainName, java.lang.String mpiId)
java.util.List<java.lang.String>	getAllMPIFromPersonByMPI(java.lang.String domainName, java.lang.String mpiId)
java.util.List<IdentityOutDTO>	getIdentitiesForDomain(java.lang.String domainName)
java.util.List<IdentityOutDTO>	getIdentitiesForDomainFiltered(java.lang.String domainName, java.util.Map<IdentityField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.util.List<IdentityOutDTO>	getIdentitiesForDomainPaginated(java.lang.String domainName, int firstEntry, int pageSize, IdentityField sortField, boolean sortIsAscending, java.util.Map<IdentityField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.lang.String	getMPIForIdentifier(java.lang.String domainName, IdentifierDTO identifier)
PersonDTO	getPersonByLocalIdentifier(java.lang.String domainName, IdentifierDTO identifier)
PersonDTO	getPersonByMPI(java.lang.String domainName, java.lang.String mpiId)
PersonDTO	getPersonByMultipleLocalIdentifier(java.lang.String domainName, java.util.List<IdentifierDTO> identifier, boolean allIdentifierRequired)
java.util.List<PersonDTO>	getPersonsForDomain(java.lang.String domainName)
java.util.List<PersonDTO>	getPersonsForDomainFiltered(java.lang.String domainName, java.util.Map<PersonField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.util.List<PersonDTO>	getPersonsForDomainPaginated(java.lang.String domainName, int firstEntry, int pageSize, PersonField sortField, boolean sortIsAscending, java.util.Map<PersonField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.util.List<PossibleMatchDTO>	getPossibleMatchesForDomain(java.lang.String domainName)
java.util.List<PossibleMatchDTO>	getPossibleMatchesForDomainFiltered(java.lang.String domainName, IdentityField sortField, boolean sortIsAscending, java.util.Map<IdentityField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.util.List<PossibleMatchDTO>	getPossibleMatchesForDomainFilteredAndPaginated(java.lang.String domainName, int firstEntry, int pageSize, IdentityField sortField, boolean sortIsAscending, java.util.Map<IdentityField,java.lang.String> filter, boolean filterIsCaseSensitive)
java.util.List<PossibleMatchDTO>	getPossibleMatchesForDomainFilteredByDefaultAndPaginated(java.lang.String domainName, int firstEntry, int pageSize, java.lang.String filter, boolean filterIsCaseSensitive, java.lang.String birthDateFormat, java.lang.String creationTimeFormat)
java.util.List<PossibleMatchForMPIDTO>	getPossibleMatchesForPerson(java.lang.String domainName, java.lang.String mpiId)
void	moveIdentitiesForIdentifierToPerson(java.lang.String domainName, IdentifierDTO identifier, java.lang.String mpiId, java.lang.String comment)
void	removePossibleMatch(long possibleMatchId, java.lang.String comment)
void	removePossibleMatches(java.util.List<java.lang.Long> possibleMatchIds, java.lang.String comment)
ResponseEntryDTO	requestMPI(java.lang.String domainName, IdentityInDTO identity, java.lang.String sourceName, java.lang.String comment)
MPIResponseDTO	requestMPIBatch(MPIRequestDTO mpiRequest)
ResponseEntryDTO	requestMPIWithConfig(java.lang.String domainName, IdentityInDTO identity, java.lang.String sourceName, java.lang.String comment, RequestConfig requestConfig)
java.util.List<PersonDTO>	searchPersonsByPDQ(SearchMask searchMask)
ResponseEntryDTO	setReferenceIdentity(java.lang.String domainName, java.lang.String mpiId, long identityId, java.lang.String comment)
ResponseEntryDTO	updatePerson(java.lang.String domainName, java.lang.String mpiId, IdentityInDTO identity, java.lang.String sourceName, boolean force, java.lang.String comment)
ResponseEntryDTO	updatePersonWithConfig(java.lang.String domainName, java.lang.String mpiId, IdentityInDTO identity, java.lang.String sourceName, boolean force, java.lang.String comment, RequestConfig requestConfig)
void	updatePrivacy(java.lang.String domainName, java.util.List<java.lang.String> mpiIds, boolean onlyReferenceIdentity)

Method Detail

requestMPI

ResponseEntryDTO requestMPI(java.lang.String domainName,
                            IdentityInDTO identity,
                            java.lang.String sourceName,
                            java.lang.String comment)
                     throws InvalidParameterException,
                            MPIException,
                            UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

requestMPIWithConfig

ResponseEntryDTO requestMPIWithConfig(java.lang.String domainName,
                                      IdentityInDTO identity,
                                      java.lang.String sourceName,
                                      java.lang.String comment,
                                      RequestConfig requestConfig)
                               throws InvalidParameterException,
                                      MPIException,
                                      UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

requestMPIBatch

MPIResponseDTO requestMPIBatch(MPIRequestDTO mpiRequest)
                        throws InvalidParameterException,
                               MPIException,
                               UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getPersonsForDomain

java.util.List<PersonDTO> getPersonsForDomain(java.lang.String domainName)
                                       throws InvalidParameterException,
                                              UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPersonsForDomainFiltered

java.util.List<PersonDTO> getPersonsForDomainFiltered(java.lang.String domainName,
                                                      java.util.Map<PersonField,java.lang.String> filter,
                                                      boolean filterIsCaseSensitive)
                                               throws InvalidParameterException,
                                                      UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPersonsForDomainPaginated

java.util.List<PersonDTO> getPersonsForDomainPaginated(java.lang.String domainName,
                                                       int firstEntry,
                                                       int pageSize,
                                                       PersonField sortField,
                                                       boolean sortIsAscending,
                                                       java.util.Map<PersonField,java.lang.String> filter,
                                                       boolean filterIsCaseSensitive)
                                                throws InvalidParameterException,
                                                       UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPersonByMPI

PersonDTO getPersonByMPI(java.lang.String domainName,
                         java.lang.String mpiId)
                  throws InvalidParameterException,
                         UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPersonByLocalIdentifier

PersonDTO getPersonByLocalIdentifier(java.lang.String domainName,
                                     IdentifierDTO identifier)
                              throws InvalidParameterException,
                                     UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPersonByMultipleLocalIdentifier

PersonDTO getPersonByMultipleLocalIdentifier(java.lang.String domainName,
                                             java.util.List<IdentifierDTO> identifier,
                                             boolean allIdentifierRequired)
                                      throws InvalidParameterException,
                                             MPIException,
                                             UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

updatePerson

ResponseEntryDTO updatePerson(java.lang.String domainName,
                              java.lang.String mpiId,
                              IdentityInDTO identity,
                              java.lang.String sourceName,
                              boolean force,
                              java.lang.String comment)
                       throws InvalidParameterException,
                              MPIException,
                              UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

updatePersonWithConfig

ResponseEntryDTO updatePersonWithConfig(java.lang.String domainName,
                                        java.lang.String mpiId,
                                        IdentityInDTO identity,
                                        java.lang.String sourceName,
                                        boolean force,
                                        java.lang.String comment,
                                        RequestConfig requestConfig)
                                 throws InvalidParameterException,
                                        MPIException,
                                        UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

addPerson

ResponseEntryDTO addPerson(java.lang.String domainName,
                           IdentityInDTO identity,
                           java.lang.String sourceName,
                           java.lang.String comment)
                    throws InvalidParameterException,
                           MPIException,
                           UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deactivatePerson

void deactivatePerson(java.lang.String domainName,
                      java.lang.String mpiId)
               throws InvalidParameterException,
                      MPIException,
                      UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deletePerson

void deletePerson(java.lang.String domainName,
                  java.lang.String mpiId)
           throws IllegalOperationException,
                  InvalidParameterException,
                  MPIException,
                  UnknownObjectException

Throws:

IllegalOperationException

InvalidParameterException

MPIException

UnknownObjectException

updatePrivacy

void updatePrivacy(java.lang.String domainName,
                   java.util.List<java.lang.String> mpiIds,
                   boolean onlyReferenceIdentity)
            throws InvalidParameterException,
                   MPIException,
                   UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getIdentitiesForDomain

java.util.List<IdentityOutDTO> getIdentitiesForDomain(java.lang.String domainName)
                                               throws InvalidParameterException,
                                                      UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentitiesForDomainFiltered

java.util.List<IdentityOutDTO> getIdentitiesForDomainFiltered(java.lang.String domainName,
                                                              java.util.Map<IdentityField,java.lang.String> filter,
                                                              boolean filterIsCaseSensitive)
                                                       throws InvalidParameterException,
                                                              UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentitiesForDomainPaginated

java.util.List<IdentityOutDTO> getIdentitiesForDomainPaginated(java.lang.String domainName,
                                                               int firstEntry,
                                                               int pageSize,
                                                               IdentityField sortField,
                                                               boolean sortIsAscending,
                                                               java.util.Map<IdentityField,java.lang.String> filter,
                                                               boolean filterIsCaseSensitive)
                                                        throws InvalidParameterException,
                                                               UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

setReferenceIdentity

ResponseEntryDTO setReferenceIdentity(java.lang.String domainName,
                                      java.lang.String mpiId,
                                      long identityId,
                                      java.lang.String comment)
                               throws InvalidParameterException,
                                      MPIException,
                                      UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deactivateIdentity

void deactivateIdentity(long identityId)
                 throws MPIException,
                        UnknownObjectException

Throws:

MPIException

UnknownObjectException

deleteIdentity

void deleteIdentity(long identityId)
             throws IllegalOperationException,
                    MPIException,
                    UnknownObjectException

Throws:

IllegalOperationException

MPIException

UnknownObjectException

addContact

IdentityOutDTO addContact(long identityId,
                          ContactInDTO contactDTO)
                   throws DuplicateEntryException,
                          InvalidParameterException,
                          MPIException,
                          UnknownObjectException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

UnknownObjectException

searchPersonsByPDQ

java.util.List<PersonDTO> searchPersonsByPDQ(SearchMask searchMask)
                                      throws InvalidParameterException,
                                             MPIException,
                                             UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getAllMPIFromPersonByMPI

java.util.List<java.lang.String> getAllMPIFromPersonByMPI(java.lang.String domainName,
                                                          java.lang.String mpiId)
                                                   throws InvalidParameterException,
                                                          MPIException,
                                                          UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getMPIForIdentifier

java.lang.String getMPIForIdentifier(java.lang.String domainName,
                                     IdentifierDTO identifier)
                              throws InvalidParameterException,
                                     UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getAllIdentifierForMPI

java.util.List<IdentifierDTO> getAllIdentifierForMPI(java.lang.String domainName,
                                                     java.lang.String mpiId)
                                              throws InvalidParameterException,
                                                     MPIException,
                                                     UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getAllIdentifierForIdentifier

java.util.List<IdentifierDTO> getAllIdentifierForIdentifier(java.lang.String domainName,
                                                            IdentifierDTO identifier)
                                                     throws InvalidParameterException,
                                                            UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

addLocalIdentifierToMPI

void addLocalIdentifierToMPI(java.lang.String domainName,
                             java.lang.String mpiId,
                             java.util.List<IdentifierDTO> localIds)
                      throws InvalidParameterException,
                             MPIException,
                             UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

addLocalIdentifierToIdentifier

void addLocalIdentifierToIdentifier(java.lang.String domainName,
                                    IdentifierDTO identifier,
                                    java.util.List<IdentifierDTO> localIds)
                             throws InvalidParameterException,
                                    MPIException,
                                    UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

getPossibleMatchesForDomain

java.util.List<PossibleMatchDTO> getPossibleMatchesForDomain(java.lang.String domainName)
                                                      throws InvalidParameterException,
                                                             UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

countPossibleMatchesForDomainFiltered

long countPossibleMatchesForDomainFiltered(java.lang.String domainName,
                                           java.util.Map<IdentityField,java.lang.String> filter,
                                           boolean filterIsCaseSensitive)
                                    throws InvalidParameterException,
                                           UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

countPossibleMatchesForDomainFilteredByDefault

long countPossibleMatchesForDomainFilteredByDefault(java.lang.String domainName,
                                                    java.lang.String filter,
                                                    boolean filterIsCaseSensitive,
                                                    java.lang.String birthDateFormat,
                                                    java.lang.String creationTimeFormat)
                                             throws InvalidParameterException,
                                                    UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchesForDomainFiltered

java.util.List<PossibleMatchDTO> getPossibleMatchesForDomainFiltered(java.lang.String domainName,
                                                                     IdentityField sortField,
                                                                     boolean sortIsAscending,
                                                                     java.util.Map<IdentityField,java.lang.String> filter,
                                                                     boolean filterIsCaseSensitive)
                                                              throws InvalidParameterException,
                                                                     UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchesForDomainFilteredAndPaginated

java.util.List<PossibleMatchDTO> getPossibleMatchesForDomainFilteredAndPaginated(java.lang.String domainName,
                                                                                 int firstEntry,
                                                                                 int pageSize,
                                                                                 IdentityField sortField,
                                                                                 boolean sortIsAscending,
                                                                                 java.util.Map<IdentityField,java.lang.String> filter,
                                                                                 boolean filterIsCaseSensitive)
                                                                          throws InvalidParameterException,
                                                                                 UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchesForDomainFilteredByDefaultAndPaginated

java.util.List<PossibleMatchDTO> getPossibleMatchesForDomainFilteredByDefaultAndPaginated(java.lang.String domainName,
                                                                                          int firstEntry,
                                                                                          int pageSize,
                                                                                          java.lang.String filter,
                                                                                          boolean filterIsCaseSensitive,
                                                                                          java.lang.String birthDateFormat,
                                                                                          java.lang.String creationTimeFormat)
                                                                                   throws InvalidParameterException,
                                                                                          UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchesForPerson

java.util.List<PossibleMatchForMPIDTO> getPossibleMatchesForPerson(java.lang.String domainName,
                                                                   java.lang.String mpiId)
                                                            throws InvalidParameterException,
                                                                   UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

removePossibleMatches

void removePossibleMatches(java.util.List<java.lang.Long> possibleMatchIds,
                           java.lang.String comment)
                    throws InvalidParameterException,
                           MPIException

Throws:

InvalidParameterException

MPIException

removePossibleMatch

void removePossibleMatch(long possibleMatchId,
                         java.lang.String comment)
                  throws InvalidParameterException,
                         MPIException

Throws:

InvalidParameterException

MPIException

assignIdentity

void assignIdentity(long possibleMatchId,
                    long winningIdentityId,
                    java.lang.String comment)
             throws InvalidParameterException,
                    MPIException

Throws:

InvalidParameterException

MPIException

moveIdentitiesForIdentifierToPerson

void moveIdentitiesForIdentifierToPerson(java.lang.String domainName,
                                         IdentifierDTO identifier,
                                         java.lang.String mpiId,
                                         java.lang.String comment)
                                  throws InvalidParameterException,
                                         MPIException,
                                         UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

externalPossibleMatchForPerson

PossibleMatchDTO externalPossibleMatchForPerson(java.lang.String domainName,
                                                java.lang.String mpiId,
                                                java.lang.String aliasMpiId)
                                         throws DuplicateEntryException,
                                                InvalidParameterException,
                                                MPIException,
                                                UnknownObjectException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

UnknownObjectException

externalPossibleMatchForIdentity

PossibleMatchDTO externalPossibleMatchForIdentity(java.lang.String domainName,
                                                  long identityId,
                                                  long aliasIdentityId)
                                           throws DuplicateEntryException,
                                                  InvalidParameterException,
                                                  MPIException,
                                                  UnknownObjectException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

UnknownObjectException