Package org.emau.icmvc.ttp.epix.service
Interface EPIXService
public interface EPIXService
- Author:
- Christian Schack, geidell
-
Method Summary
Modifier and TypeMethodDescriptionaddContact
(long identityId, ContactInDTO contactDTO) void
addLocalIdentifierToActivePersonWithMPI
(String domainName, String mpiId, List<IdentifierDTO> localIds) void
addLocalIdentifierToIdentifier
(String domainName, IdentifierDTO identifier, List<IdentifierDTO> localIds) void
addLocalIdentifierToMPI
(String domainName, String mpiId, List<IdentifierDTO> localIds) Deprecated.use addLocalIdentifierToActivePersonWithMPI (name change for clarity reasons)addPerson
(String domainName, IdentityInDTO identity, String sourceName, String comment) void
assignIdentity
(long possibleMatchId, long winningIdentityId, String comment) long
countActivePersonsForDomainFiltered
(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) long
countIdentitiesForDomainFiltered
(String domainName, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) long
countPersonsForDomainFiltered
(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) Deprecated.use countActivePersonsForDomainFiltered (name change for clarity reasons)long
countPossibleMatchesForDomain
(String domainName) Counts all possible matches for the given domain.long
countPossibleMatchesForDomainFiltered
(String domainName, PaginationConfig paginationConfig) Counts matchingPossibleMatchDTO
entries.void
deactivateContact
(long contactId) void
deactivateIdentity
(long identityId) void
deactivatePerson
(String domainName, String mpiId) void
deleteContact
(long contactId) void
deleteIdentity
(long identityId) void
deletePerson
(String domainName, String mpiId) externalPossibleMatchForIdentity
(String domainName, long identityId, long aliasIdentityId) externalPossibleMatchForPerson
(String domainName, String mpiId, String aliasMpiId) getActivePersonByLocalIdentifier
(String domainName, IdentifierDTO identifier) getActivePersonByMPI
(String domainName, String mpiId) returns the active person which is currently associated with the given mpiId.getActivePersonByMultipleLocalIdentifier
(String domainName, List<IdentifierDTO> identifier, boolean allIdentifierRequired) getActivePersonsByMPIBatch
(String domainName, List<String> mpiIds) returns the active persons which are currently associated with the given mpiIds.getActivePersonsForDomain
(String domainName) getActivePersonsForDomainFiltered
(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) getActivePersonsForDomainPaginated
(String domainName, int firstEntry, int pageSize, PersonField sortField, boolean sortIsAscending, Map<PersonField, String> filter, boolean filterIsCaseSensitive) getAllIdentifierForAcivePersonWithMPI
(String domainName, String mpiId) getAllIdentifierForIdentifier
(String domainName, IdentifierDTO identifier) getAllIdentifierForMPI
(String domainName, String mpiId) Deprecated.use getAllIdentifierForAcivePersonWithMPI (name change for clarity reasons)getAllMPIFromActivePersonByMPI
(String domainName, String mpiId) getAllMPIFromPersonByMPI
(String domainName, String mpiId) Deprecated.use getAllMPIFromActivePersonByMPI (name change for clarity reasons)getIdentitiesForDomain
(String domainName) getIdentitiesForDomainFiltered
(String domainName, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) getIdentitiesForDomainPaginated
(String domainName, int firstEntry, int pageSize, IdentityField sortField, boolean sortIsAscending, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) getMPIForIdentifier
(String domainName, IdentifierDTO identifier) getPersonByFirstMPI
(String domainName, String mpiId) returns the person (may be deactivated) with the given mpiId.getPersonByLocalIdentifier
(String domainName, IdentifierDTO identifier) Deprecated.use getActivePersonByLocalIdentifier (name change for clarity reasons)getPersonByMPI
(String domainName, String mpiId) Deprecated.use getActivePersonByMPI (name change for clarity reasons)getPersonByMultipleLocalIdentifier
(String domainName, List<IdentifierDTO> identifier, boolean allIdentifierRequired) Deprecated.use getActivePersonByMultipleLocalIdentifier (name change for clarity reasons)getPersonsByFirstMPIBatch
(String domainName, List<String> mpiIds) returns the persons (may be deactivated) with the given mpiIds.getPersonsByMPIBatch
(String domainName, List<String> mpiIds) Deprecated.use getActivePersonsByMPIBatch (name change for clarity reasons)getPersonsForDomain
(String domainName) Deprecated.use getActivePersonsForDomain (name change for clarity reasons)getPersonsForDomainFiltered
(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) Deprecated.use getActivePersonsForDomainFiltered (name change for clarity reasons)getPersonsForDomainPaginated
(String domainName, int firstEntry, int pageSize, PersonField sortField, boolean sortIsAscending, Map<PersonField, String> filter, boolean filterIsCaseSensitive) Deprecated.use getActivePersonsForDomainPaginated (name change for clarity reasons)getPossibleMatchesForDomain
(String domainName) Returns all possible matches for the given domain.getPossibleMatchesForDomainFiltered
(String domainName, PaginationConfig paginationConfig) Returns matchingPossibleMatchDTO
entries.getPossibleMatchesForPerson
(String domainName, String mpiId) void
moveIdentitiesForIdentifierToPerson
(String domainName, IdentifierDTO identifier, String mpiId, String comment) boolean
prioritizePossibleMatch
(long linkId, PossibleMatchPriority priority) Marks a possible match as postponed (or not).removeLocalIdentifier
(String domainName, List<IdentifierDTO> localIds) Removes identifiers in the given domain from the associated persons' identities and from the DB if it is not used in other domains.void
removePossibleMatch
(long possibleMatchId, String comment) void
removePossibleMatches
(List<Long> possibleMatchIds, String comment) requestMPI
(String domainName, IdentityInDTO identity, String sourceName, String comment) requestMPIBatch
(MPIRequestDTO mpiRequest) requestMPIWithConfig
(String domainName, IdentityInDTO identity, String sourceName, String comment, RequestConfig requestConfig) searchPersonsByPDQ
(SearchMask searchMask) setReferenceIdentity
(String domainName, String mpiId, long identityId, String comment) updateActivePerson
(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment) updateActivePersonWithConfig
(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig) updatePerson
(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment) updatePersonWithConfig
(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig) void
updatePrivacy
(String domainName, List<String> mpiIds, boolean onlyReferenceIdentity)
-
Method Details
-
requestMPI
ResponseEntryDTO requestMPI(String domainName, IdentityInDTO identity, String sourceName, String comment) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
requestMPIWithConfig
ResponseEntryDTO requestMPIWithConfig(String domainName, IdentityInDTO identity, String sourceName, String comment, RequestConfig requestConfig) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
requestMPIBatch
MPIResponseDTO requestMPIBatch(MPIRequestDTO mpiRequest) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
getPersonsForDomain
@Deprecated List<PersonDTO> getPersonsForDomain(String domainName) throws InvalidParameterException, UnknownObjectException Deprecated.use getActivePersonsForDomain (name change for clarity reasons) -
getActivePersonsForDomain
List<PersonDTO> getActivePersonsForDomain(String domainName) throws InvalidParameterException, UnknownObjectException -
getPersonsForDomainFiltered
@Deprecated List<PersonDTO> getPersonsForDomainFiltered(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectExceptionDeprecated.use getActivePersonsForDomainFiltered (name change for clarity reasons) -
getActivePersonsForDomainFiltered
List<PersonDTO> getActivePersonsForDomainFiltered(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
getPersonsForDomainPaginated
@Deprecated List<PersonDTO> getPersonsForDomainPaginated(String domainName, int firstEntry, int pageSize, PersonField sortField, boolean sortIsAscending, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectExceptionDeprecated.use getActivePersonsForDomainPaginated (name change for clarity reasons) -
getActivePersonsForDomainPaginated
List<PersonDTO> getActivePersonsForDomainPaginated(String domainName, int firstEntry, int pageSize, PersonField sortField, boolean sortIsAscending, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
countPersonsForDomainFiltered
@Deprecated long countPersonsForDomainFiltered(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectExceptionDeprecated.use countActivePersonsForDomainFiltered (name change for clarity reasons) -
countActivePersonsForDomainFiltered
long countActivePersonsForDomainFiltered(String domainName, Map<PersonField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
getPersonByFirstMPI
PersonDTO getPersonByFirstMPI(String domainName, String mpiId) throws InvalidParameterException, UnknownObjectException returns the person (may be deactivated) with the given mpiId.- Parameters:
domainName
-mpiId
-- Returns:
- Throws:
InvalidParameterException
UnknownObjectException
-
getPersonsByFirstMPIBatch
List<PersonDTO> getPersonsByFirstMPIBatch(String domainName, List<String> mpiIds) throws InvalidParameterException, UnknownObjectException returns the persons (may be deactivated) with the given mpiIds.- Parameters:
domainName
-mpiIds
-- Returns:
- Throws:
InvalidParameterException
UnknownObjectException
-
getPersonByMPI
@Deprecated PersonDTO getPersonByMPI(String domainName, String mpiId) throws InvalidParameterException, UnknownObjectException Deprecated.use getActivePersonByMPI (name change for clarity reasons) -
getActivePersonByMPI
PersonDTO getActivePersonByMPI(String domainName, String mpiId) throws InvalidParameterException, UnknownObjectException returns the active person which is currently associated with the given mpiId. this could be a person with another mpiId as first mpi (-> merge).- Parameters:
domainName
-mpiId
-- Returns:
- Throws:
InvalidParameterException
UnknownObjectException
-
getPersonsByMPIBatch
@Deprecated List<PersonDTO> getPersonsByMPIBatch(String domainName, List<String> mpiIds) throws InvalidParameterException, UnknownObjectException Deprecated.use getActivePersonsByMPIBatch (name change for clarity reasons) -
getActivePersonsByMPIBatch
List<PersonDTO> getActivePersonsByMPIBatch(String domainName, List<String> mpiIds) throws InvalidParameterException, UnknownObjectException returns the active persons which are currently associated with the given mpiIds. this could be persons with another mpiId as first mpi (-> merge).- Parameters:
domainName
-mpiIds
-- Returns:
- Throws:
InvalidParameterException
UnknownObjectException
-
getPersonByLocalIdentifier
@Deprecated PersonDTO getPersonByLocalIdentifier(String domainName, IdentifierDTO identifier) throws InvalidParameterException, UnknownObjectException Deprecated.use getActivePersonByLocalIdentifier (name change for clarity reasons) -
getActivePersonByLocalIdentifier
PersonDTO getActivePersonByLocalIdentifier(String domainName, IdentifierDTO identifier) throws InvalidParameterException, UnknownObjectException -
getPersonByMultipleLocalIdentifier
@Deprecated PersonDTO getPersonByMultipleLocalIdentifier(String domainName, List<IdentifierDTO> identifier, boolean allIdentifierRequired) throws InvalidParameterException, MPIException, UnknownObjectException Deprecated.use getActivePersonByMultipleLocalIdentifier (name change for clarity reasons) -
getActivePersonByMultipleLocalIdentifier
PersonDTO getActivePersonByMultipleLocalIdentifier(String domainName, List<IdentifierDTO> identifier, boolean allIdentifierRequired) throws InvalidParameterException, MPIException, UnknownObjectException -
updatePerson
ResponseEntryDTO updatePerson(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
updatePersonWithConfig
ResponseEntryDTO updatePersonWithConfig(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
updateActivePerson
ResponseEntryDTO updateActivePerson(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
updateActivePersonWithConfig
ResponseEntryDTO updateActivePersonWithConfig(String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig) throws InvalidParameterException, MPIException, UnknownObjectException, ValidatorException -
addPerson
ResponseEntryDTO addPerson(String domainName, IdentityInDTO identity, String sourceName, String comment) throws InvalidParameterException, MPIException, UnknownObjectException -
deactivatePerson
void deactivatePerson(String domainName, String mpiId) throws InvalidParameterException, MPIException, UnknownObjectException -
deletePerson
void deletePerson(String domainName, String mpiId) throws IllegalOperationException, InvalidParameterException, MPIException, UnknownObjectException -
updatePrivacy
void updatePrivacy(String domainName, List<String> mpiIds, boolean onlyReferenceIdentity) throws InvalidParameterException, MPIException, UnknownObjectException -
getIdentitiesForDomain
List<IdentityOutDTO> getIdentitiesForDomain(String domainName) throws InvalidParameterException, UnknownObjectException -
getIdentitiesForDomainFiltered
List<IdentityOutDTO> getIdentitiesForDomainFiltered(String domainName, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
getIdentitiesForDomainPaginated
List<IdentityOutDTO> getIdentitiesForDomainPaginated(String domainName, int firstEntry, int pageSize, IdentityField sortField, boolean sortIsAscending, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
countIdentitiesForDomainFiltered
long countIdentitiesForDomainFiltered(String domainName, Map<IdentityField, String> filter, boolean filterIsCaseSensitive) throws InvalidParameterException, UnknownObjectException -
setReferenceIdentity
ResponseEntryDTO setReferenceIdentity(String domainName, String mpiId, long identityId, String comment) throws InvalidParameterException, MPIException, UnknownObjectException -
deactivateIdentity
- Throws:
MPIException
UnknownObjectException
-
deleteIdentity
void deleteIdentity(long identityId) throws IllegalOperationException, MPIException, UnknownObjectException -
addContact
IdentityOutDTO addContact(long identityId, ContactInDTO contactDTO) throws DuplicateEntryException, InvalidParameterException, MPIException, UnknownObjectException -
deactivateContact
- Throws:
UnknownObjectException
-
deleteContact
-
searchPersonsByPDQ
List<PersonDTO> searchPersonsByPDQ(SearchMask searchMask) throws InvalidParameterException, MPIException, UnknownObjectException -
getAllMPIFromPersonByMPI
@Deprecated List<String> getAllMPIFromPersonByMPI(String domainName, String mpiId) throws InvalidParameterException, MPIException, UnknownObjectException Deprecated.use getAllMPIFromActivePersonByMPI (name change for clarity reasons) -
getAllMPIFromActivePersonByMPI
List<String> getAllMPIFromActivePersonByMPI(String domainName, String mpiId) throws InvalidParameterException, MPIException, UnknownObjectException -
getMPIForIdentifier
String getMPIForIdentifier(String domainName, IdentifierDTO identifier) throws InvalidParameterException, UnknownObjectException -
getAllIdentifierForMPI
@Deprecated List<IdentifierDTO> getAllIdentifierForMPI(String domainName, String mpiId) throws InvalidParameterException, MPIException, UnknownObjectException Deprecated.use getAllIdentifierForAcivePersonWithMPI (name change for clarity reasons) -
getAllIdentifierForAcivePersonWithMPI
List<IdentifierDTO> getAllIdentifierForAcivePersonWithMPI(String domainName, String mpiId) throws InvalidParameterException, MPIException, UnknownObjectException -
getAllIdentifierForIdentifier
List<IdentifierDTO> getAllIdentifierForIdentifier(String domainName, IdentifierDTO identifier) throws InvalidParameterException, UnknownObjectException -
addLocalIdentifierToMPI
@Deprecated void addLocalIdentifierToMPI(String domainName, String mpiId, List<IdentifierDTO> localIds) throws InvalidParameterException, MPIException, UnknownObjectException Deprecated.use addLocalIdentifierToActivePersonWithMPI (name change for clarity reasons) -
addLocalIdentifierToActivePersonWithMPI
void addLocalIdentifierToActivePersonWithMPI(String domainName, String mpiId, List<IdentifierDTO> localIds) throws InvalidParameterException, MPIException, UnknownObjectException -
addLocalIdentifierToIdentifier
void addLocalIdentifierToIdentifier(String domainName, IdentifierDTO identifier, List<IdentifierDTO> localIds) throws InvalidParameterException, MPIException, UnknownObjectException -
removeLocalIdentifier
Map<IdentifierDTO,IdentifierDeletionResult> removeLocalIdentifier(String domainName, List<IdentifierDTO> localIds) throws InvalidParameterException, MPIException, UnknownObjectException Removes identifiers in the given domain from the associated persons' identities and from the DB if it is not used in other domains. An identifier cannot be deleted if its identifier domain is the MPI domain of the given domain.- Parameters:
domainName
- the name of the domain to delete the local identifier inlocalIds
- the spec of the local identifiers to delete- Returns:
- a map with the identifiers and their deletion result
- Throws:
UnknownObjectException
- if domain does not existInvalidParameterException
MPIException
-
getPossibleMatchesForDomain
List<PossibleMatchDTO> getPossibleMatchesForDomain(String domainName) throws InvalidParameterException, UnknownObjectException Returns all possible matches for the given domain.- Parameters:
domainName
- the name of the domain- Throws:
InvalidParameterException
UnknownObjectException
-
countPossibleMatchesForDomain
long countPossibleMatchesForDomain(String domainName) throws InvalidParameterException, UnknownObjectException Counts all possible matches for the given domain.- Parameters:
domainName
- the name of the domain- Throws:
InvalidParameterException
UnknownObjectException
-
getPossibleMatchesForDomainFiltered
List<PossibleMatchDTO> getPossibleMatchesForDomainFiltered(String domainName, PaginationConfig paginationConfig) throws InvalidParameterException, UnknownObjectException Returns matchingPossibleMatchDTO
entries. IfIdentityField.NONE
is the only key in the filter map, then search for the corresponding pattern in all required fields (as defined in the configuration container) linked by OR (disjunction), otherwise search in all given fields for the respective pattern.- Parameters:
domainName
- the name of the domainpaginationConfig
- the pagination configuration- Returns:
- matching
PossibleMatchDTO
entries. - Throws:
UnknownObjectException
- for a wrong domain nameInvalidParameterException
-
countPossibleMatchesForDomainFiltered
long countPossibleMatchesForDomainFiltered(String domainName, PaginationConfig paginationConfig) throws InvalidParameterException, UnknownObjectException Counts matchingPossibleMatchDTO
entries. IfIdentityField.NONE
is the only key in the filter map, then search for the corresponding pattern in all required fields (as defined in the configuration container) linked by OR (disjunction), otherwise search in all given fields for the respective pattern linked by AND (conjunction).- Parameters:
domainName
- the name of the domainpaginationConfig
- the pagination configuration- Returns:
- number of matching
PossibleMatchDTO
entries. - Throws:
UnknownObjectException
- for a wrong domain nameInvalidParameterException
-
getPossibleMatchesForPerson
List<PossibleMatchForMPIDTO> getPossibleMatchesForPerson(String domainName, String mpiId) throws InvalidParameterException, UnknownObjectException -
removePossibleMatches
void removePossibleMatches(List<Long> possibleMatchIds, String comment) throws InvalidParameterException, MPIException -
removePossibleMatch
void removePossibleMatch(long possibleMatchId, String comment) throws InvalidParameterException, MPIException -
prioritizePossibleMatch
boolean prioritizePossibleMatch(long linkId, PossibleMatchPriority priority) throws InvalidParameterException, MPIException Marks a possible match as postponed (or not).- Parameters:
linkId
- the link ID- Returns:
- true if the postponed status actually has changed
- Throws:
InvalidParameterException
- for invalid parametersMPIException
- for problems with MPI
-
assignIdentity
void assignIdentity(long possibleMatchId, long winningIdentityId, String comment) throws InvalidParameterException, MPIException, UnknownObjectException -
moveIdentitiesForIdentifierToPerson
void moveIdentitiesForIdentifierToPerson(String domainName, IdentifierDTO identifier, String mpiId, String comment) throws InvalidParameterException, MPIException, UnknownObjectException -
externalPossibleMatchForPerson
PossibleMatchDTO externalPossibleMatchForPerson(String domainName, String mpiId, String aliasMpiId) throws DuplicateEntryException, InvalidParameterException, MPIException, UnknownObjectException -
externalPossibleMatchForIdentity
PossibleMatchDTO externalPossibleMatchForIdentity(String domainName, long identityId, long aliasIdentityId) throws DuplicateEntryException, InvalidParameterException, MPIException, UnknownObjectException
-