Package org.emau.icmvc.ttp.epix.service

Interface EPIXServiceWithNotification

public interface EPIXServiceWithNotification

Author:

geidell

Method Summary

Modifier and Type	Method	Description
IdentityOutDTO	addContact(String notificationClientID, long identityId, ContactInDTO contactDTO)
void	addLocalIdentifierToActivePersonWithMPI(String notificationClientID, String domainName, String mpiId, List<IdentifierDTO> localIds)
void	addLocalIdentifierToIdentifier(String notificationClientID, String domainName, IdentifierDTO identifier, List<IdentifierDTO> localIds)
void	addLocalIdentifierToMPI(String notificationClientID, String domainName, String mpiId, List<IdentifierDTO> localIds)	Deprecated. use addLocalIdentifierToActivePersonWithMPI (name change for clarity reasons)
ResponseEntryDTO	addPerson(String notificationClientID, String domainName, IdentityInDTO identity, String sourceName, String comment)
void	assignIdentity(String notificationClientID, long possibleMatchId, long winningIdentityId, String comment)
void	deactivateContact(String notificationClientId, Long contactId)
void	deactivateIdentity(String notificationClientID, long identityId)
void	deactivatePerson(String notificationClientID, String domainName, String mpiId)
void	deleteContact(String notificationClientId, Long contactId)
void	deleteIdentity(String notificationClientID, long identityId)
void	deletePerson(String notificationClientID, String domainName, String mpiId)
void	moveIdentitiesForIdentifierToPerson(String notificationClientID, String domainName, IdentifierDTO identifier, String mpiId, String comment)
Map<IdentifierDTO,IdentifierDeletionResult>	removeLocalIdentifier(String notificationClientID, 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.
ResponseEntryDTO	requestMPI(String notificationClientID, String domainName, IdentityInDTO identity, String sourceName, String comment)
MPIResponseDTO	requestMPIBatch(String notificationClientID, MPIRequestDTO mpiRequest)
ResponseEntryDTO	requestMPIWithConfig(String notificationClientID, String domainName, IdentityInDTO identity, String sourceName, String comment, RequestConfig requestConfig)
ResponseEntryDTO	setReferenceIdentity(String notificationClientID, String domainName, String mpiId, long identityId, String comment)
ResponseEntryDTO	updateActivePerson(String notificationClientID, String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment)
ResponseEntryDTO	updateActivePersonWithConfig(String notificationClientID, String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig)
ResponseEntryDTO	updatePerson(String notificationClientID, String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment)
ResponseEntryDTO	updatePersonWithConfig(String notificationClientID, String domainName, String mpiId, IdentityInDTO identity, String sourceName, boolean force, String comment, RequestConfig requestConfig)

Method Details

requestMPI

ResponseEntryDTO requestMPI(String notificationClientID,
 String domainName,
 IdentityInDTO identity,
 String sourceName,
 String comment)
                     throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

requestMPIWithConfig

ResponseEntryDTO requestMPIWithConfig(String notificationClientID,
 String domainName,
 IdentityInDTO identity,
 String sourceName,
 String comment,
 RequestConfig requestConfig)
                               throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

requestMPIBatch

MPIResponseDTO requestMPIBatch(String notificationClientID,
 MPIRequestDTO mpiRequest)
                        throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

updatePerson

ResponseEntryDTO updatePerson(String notificationClientID,
 String domainName,
 String mpiId,
 IdentityInDTO identity,
 String sourceName,
 boolean force,
 String comment)
                       throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

updatePersonWithConfig

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

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

updateActivePerson

ResponseEntryDTO updateActivePerson(String notificationClientID,
 String domainName,
 String mpiId,
 IdentityInDTO identity,
 String sourceName,
 boolean force,
 String comment)
                             throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

updateActivePersonWithConfig

ResponseEntryDTO updateActivePersonWithConfig(String notificationClientID,
 String domainName,
 String mpiId,
 IdentityInDTO identity,
 String sourceName,
 boolean force,
 String comment,
 RequestConfig requestConfig)
                                       throws InvalidParameterException,
MPIException,
UnknownObjectException,
ValidatorException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

ValidatorException

addPerson

ResponseEntryDTO addPerson(String notificationClientID,
 String domainName,
 IdentityInDTO identity,
 String sourceName,
 String comment)
                    throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deactivatePerson

void deactivatePerson(String notificationClientID,
 String domainName,
 String mpiId)
               throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deletePerson

void deletePerson(String notificationClientID,
 String domainName,
 String mpiId)
           throws IllegalOperationException,
InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

IllegalOperationException

InvalidParameterException

MPIException

UnknownObjectException

setReferenceIdentity

ResponseEntryDTO setReferenceIdentity(String notificationClientID,
 String domainName,
 String mpiId,
 long identityId,
 String comment)
                               throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deactivateIdentity

void deactivateIdentity(String notificationClientID,
 long identityId)
                 throws MPIException,
UnknownObjectException

Throws:

MPIException

UnknownObjectException

deleteIdentity

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

Throws:

IllegalOperationException

MPIException

UnknownObjectException

addContact

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

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

UnknownObjectException

deactivateContact

void deactivateContact(String notificationClientId,
 Long contactId)
                throws UnknownObjectException

Throws:

UnknownObjectException

deleteContact

void deleteContact(String notificationClientId,
 Long contactId)
            throws IllegalOperationException,
UnknownObjectException

Throws:

IllegalOperationException

UnknownObjectException

addLocalIdentifierToMPI

@Deprecated(forRemoval=false)
void addLocalIdentifierToMPI(String notificationClientID,
 String domainName,
 String mpiId,
 List<IdentifierDTO> localIds)
                      throws InvalidParameterException,
MPIException,
UnknownObjectException

Deprecated.

use addLocalIdentifierToActivePersonWithMPI (name change for clarity reasons)

Throws:

InvalidParameterException

MPIException

UnknownObjectException

addLocalIdentifierToActivePersonWithMPI

void addLocalIdentifierToActivePersonWithMPI(String notificationClientID,
 String domainName,
 String mpiId,
 List<IdentifierDTO> localIds)
                                      throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

addLocalIdentifierToIdentifier

void addLocalIdentifierToIdentifier(String notificationClientID,
 String domainName,
 IdentifierDTO identifier,
 List<IdentifierDTO> localIds)
                             throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

removeLocalIdentifier

Map<IdentifierDTO,IdentifierDeletionResult> removeLocalIdentifier(String notificationClientID,
 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:

notificationClientID - an identifier for the client passed along with the notification

domainName - the name of the domain to delete the local identifier in

localIds - the spec of the local identifiers to delete

Returns:

a map with the identifiers and their deletion result

Throws:

UnknownObjectException - if domain does not exist

InvalidParameterException

MPIException

assignIdentity

void assignIdentity(String notificationClientID,
 long possibleMatchId,
 long winningIdentityId,
 String comment)
             throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

moveIdentitiesForIdentifierToPerson

void moveIdentitiesForIdentifierToPerson(String notificationClientID,
 String domainName,
 IdentifierDTO identifier,
 String mpiId,
 String comment)
                                  throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException