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

Interface EPIXManagementService

public interface EPIXManagementService

Author:

geidell

Method Summary

Modifier and Type	Method	Description
DomainDTO	addDomain(DomainDTO domain)
IdentifierDomainDTO	addIdentifierDomain(IdentifierDomainDTO identifierDomain)
SourceDTO	addSource(SourceDTO source)
long	countIdentityHistoriesForDomain(String domainName, PaginationConfig paginationConfig)	Counts matching IdentityHistoryDTO entries.
long	countPossibleMatchHistoriesForDomain(String domainName, PaginationConfig paginationConfig)	Counts matching PossibleMatchHistoryDTO entries.
void	deleteDomain(String domainName, boolean force)
void	deleteIdentifierDomain(String identifierDomainName)
void	deleteSource(String sourceName)
String	encodeMatchingConfiguration(ConfigurationContainer config)	Parses a matching configuration encoded as XML into a ConfigurationContainer.
ConfigurationContainer	getConfigurationForDomain(String domainName)
List<IdentityOutDTO>	getDeacticatedIdentitiesForDomain(String domainName)
List<PersonDTO>	getDeactivatedPersonsForDomain(String domainName)
List<ReasonDTO>	getDefinedDeduplicationReasons(String domainName)
DomainDTO	getDomain(String domainName)
List<DomainDTO>	getDomains()
List<ContactHistoryDTO>	getHistoryForContact(long contactId)
List<IdentifierHistoryDTO>	getHistoryForIdentifier(String identifierDomainName, String value)
List<IdentityHistoryDTO>	getHistoryForIdentity(long identityId)
List<PersonHistoryDTO>	getHistoryForPerson(String domainName, String mpiId)
IdentifierDomainDTO	getIdentifierDomain(String identifierDomainName)
List<IdentifierDomainDTO>	getIdentifierDomains()
IdentityOutDTO	getIdentityById(long id)
List<IdentityHistoryDTO>	getIdentityHistoriesForDomain(String domainName)
List<IdentityHistoryDTO>	getIdentityHistoriesForDomainFiltered(String domainName, Map<IdentityField,String> filter, boolean filterIsCaseSensitive)
List<IdentityHistoryDTO>	getIdentityHistoriesForDomainPaginated(String domainName, PaginationConfig paginationConfig)	Returns matching IdentityHistoryDTO entries.
List<IdentityHistoryDTO>	getIdentityHistoryByPersonId(Long personId)
PersonDTO	getPersonById(long id)
List<PossibleMatchHistoryDTO>	getPossibleMatchHistoryByIdentity(long identityId)
List<PossibleMatchHistoryDTO>	getPossibleMatchHistoryForPerson(String domainName, String mpiId)
List<PossibleMatchHistoryDTO>	getPossibleMatchHistoryForUpdatedIdentity(long updatedIdentityId)
SourceDTO	getSource(String sourceName)
List<SourceDTO>	getSources()
ConfigurationContainer	parseMatchingConfiguration(String xml)	Parses a matching configuration encoded as XML into a ConfigurationContainer.
DomainDTO	updateDomain(DomainDTO domain)
DomainDTO	updateDomainInUse(String domainName, String label, String description)
IdentifierDomainDTO	updateIdentifierDomain(IdentifierDomainDTO identifierDomain)
SourceDTO	updateSource(SourceDTO source)

Method Details

addIdentifierDomain

IdentifierDomainDTO addIdentifierDomain(IdentifierDomainDTO identifierDomain)
                                 throws DuplicateEntryException,
InvalidParameterException,
MPIException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

getIdentifierDomain

IdentifierDomainDTO getIdentifierDomain(String identifierDomainName)
                                 throws UnknownObjectException,
InvalidParameterException

Throws:

UnknownObjectException

InvalidParameterException

getIdentifierDomains

List<IdentifierDomainDTO> getIdentifierDomains()

updateIdentifierDomain

IdentifierDomainDTO updateIdentifierDomain(IdentifierDomainDTO identifierDomain)
                                    throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deleteIdentifierDomain

void deleteIdentifierDomain(String identifierDomainName)
                     throws InvalidParameterException,
MPIException,
ObjectInUseException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

ObjectInUseException

UnknownObjectException

addDomain

DomainDTO addDomain(DomainDTO domain)
             throws DuplicateEntryException,
InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

UnknownObjectException

getDomain

DomainDTO getDomain(String domainName)
             throws UnknownObjectException,
InvalidParameterException

Throws:

UnknownObjectException

InvalidParameterException

getDomains

List<DomainDTO> getDomains()

updateDomain

DomainDTO updateDomain(DomainDTO domain)
                throws InvalidParameterException,
MPIException,
ObjectInUseException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

ObjectInUseException

UnknownObjectException

updateDomainInUse

DomainDTO updateDomainInUse(String domainName,
 String label,
 String description)
                     throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deleteDomain

void deleteDomain(String domainName,
 boolean force)
           throws InvalidParameterException,
MPIException,
ObjectInUseException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

ObjectInUseException

UnknownObjectException

addSource

SourceDTO addSource(SourceDTO source)
             throws DuplicateEntryException,
InvalidParameterException,
MPIException

Throws:

DuplicateEntryException

InvalidParameterException

MPIException

getSource

SourceDTO getSource(String sourceName)
             throws UnknownObjectException,
InvalidParameterException

Throws:

UnknownObjectException

InvalidParameterException

getSources

List<SourceDTO> getSources()

updateSource

SourceDTO updateSource(SourceDTO source)
                throws InvalidParameterException,
MPIException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

UnknownObjectException

deleteSource

void deleteSource(String sourceName)
           throws InvalidParameterException,
MPIException,
ObjectInUseException,
UnknownObjectException

Throws:

InvalidParameterException

MPIException

ObjectInUseException

UnknownObjectException

getPersonById

PersonDTO getPersonById(long id)
                 throws UnknownObjectException

Throws:

UnknownObjectException

getIdentityById

IdentityOutDTO getIdentityById(long id)
                        throws UnknownObjectException

Throws:

UnknownObjectException

getDeactivatedPersonsForDomain

List<PersonDTO> getDeactivatedPersonsForDomain(String domainName)
                                        throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getDeacticatedIdentitiesForDomain

List<IdentityOutDTO> getDeacticatedIdentitiesForDomain(String domainName)
                                                throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getHistoryForPerson

List<PersonHistoryDTO> getHistoryForPerson(String domainName,
 String mpiId)
                                    throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentityHistoriesForDomain

List<IdentityHistoryDTO> getIdentityHistoriesForDomain(String domainName)
                                                throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentityHistoriesForDomainFiltered

List<IdentityHistoryDTO> getIdentityHistoriesForDomainFiltered(String domainName,
 Map<IdentityField,String> filter,
 boolean filterIsCaseSensitive)
                                                        throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentityHistoriesForDomainPaginated

List<IdentityHistoryDTO> getIdentityHistoriesForDomainPaginated(String domainName,
 PaginationConfig paginationConfig)
                                                         throws InvalidParameterException,
UnknownObjectException

Returns matching IdentityHistoryDTO entries. If IdentityField.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 domain

paginationConfig - the pagination configuration

Returns:

matching IdentityHistoryDTO entries.

Throws:

UnknownObjectException - for a wrong domain name

InvalidParameterException

countIdentityHistoriesForDomain

long countIdentityHistoriesForDomain(String domainName,
 PaginationConfig paginationConfig)
                              throws InvalidParameterException,
UnknownObjectException

Counts matching IdentityHistoryDTO entries. If IdentityField.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 domain

paginationConfig - the pagination configuration

Returns:

number of matching IdentityHistoryDTO entries.

Throws:

UnknownObjectException - for a wrong domain name

InvalidParameterException

countPossibleMatchHistoriesForDomain

long countPossibleMatchHistoriesForDomain(String domainName,
 PaginationConfig paginationConfig)
                                   throws UnknownObjectException,
InvalidParameterException

Counts matching PossibleMatchHistoryDTO entries. w.r.t the given domain and pagination config.

Currently only the domain and the solution filter will be used for the search! A later implementation also should respect the identity filter map.

Parameters:

domainName - the name of the domain

paginationConfig - the pagination configuration

Returns:

number of matching PossibleMatchHistoryDTO entries

Throws:

UnknownObjectException - for a wrong domain name

InvalidParameterException

getHistoryForIdentity

List<IdentityHistoryDTO> getHistoryForIdentity(long identityId)
                                        throws UnknownObjectException

Throws:

UnknownObjectException

getHistoryForContact

List<ContactHistoryDTO> getHistoryForContact(long contactId)
                                      throws UnknownObjectException

Throws:

UnknownObjectException

getHistoryForIdentifier

List<IdentifierHistoryDTO> getHistoryForIdentifier(String identifierDomainName,
 String value)
                                            throws UnknownObjectException

Throws:

UnknownObjectException

getPossibleMatchHistoryForPerson

List<PossibleMatchHistoryDTO> getPossibleMatchHistoryForPerson(String domainName,
 String mpiId)
                                                        throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchHistoryForUpdatedIdentity

List<PossibleMatchHistoryDTO> getPossibleMatchHistoryForUpdatedIdentity(long updatedIdentityId)
                                                                 throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getPossibleMatchHistoryByIdentity

List<PossibleMatchHistoryDTO> getPossibleMatchHistoryByIdentity(long identityId)
                                                         throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getConfigurationForDomain

ConfigurationContainer getConfigurationForDomain(String domainName)
                                          throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

getIdentityHistoryByPersonId

List<IdentityHistoryDTO> getIdentityHistoryByPersonId(Long personId)
                                               throws UnknownObjectException

Throws:

UnknownObjectException

getDefinedDeduplicationReasons

List<ReasonDTO> getDefinedDeduplicationReasons(String domainName)
                                        throws InvalidParameterException,
UnknownObjectException

Throws:

InvalidParameterException

UnknownObjectException

parseMatchingConfiguration

ConfigurationContainer parseMatchingConfiguration(String xml)
                                           throws InvalidParameterException,
MPIException

Parses a matching configuration encoded as XML into a ConfigurationContainer.

Parameters:

xml - the configuration XML

Returns:

a ConfigurationContainer describing the configuration

Throws:

InvalidParameterException - if the XML is null or empty

MPIException - if parsing failed

encodeMatchingConfiguration

String encodeMatchingConfiguration(ConfigurationContainer config)
                            throws InvalidParameterException,
MPIException

Parses a matching configuration encoded as XML into a ConfigurationContainer.

Parameters:

config - a ConfigurationContainer describing the configuration

Returns:

the configuration as XML

Throws:

InvalidParameterException - if the config is null

MPIException - if encoding failed