Dynamic Web Service Methods

A set of Java methods are created in the Master Index EJB project for use in the client applications that call Master Index functions. These methods wrap static Java API methods, allowing them to work with the dynamic object classes. Many of these methods return objects of the dynamic object type, or they use these objects as parameters. In the following methods described for web services, ObjectName indicates the name of the parent object.

activateEnterpriseRecord getSystemRecord activateSystemRecord getSystemRecordsByEUID addSystemRecord getSystemRecordsByEUIDStatus deactivateEnterpriseRecord lookupLIDs deactivateSystemRecord lookupPotentialDuplicates executeMatch mergeEnterpriseRecord executeMatchUpdate mergeSystemRecord getEnterpriseRecordByEUID searchBlock getEnterpriseRecordByLID searchExact getEUID searchPhonetic getLIDs transferSystemRecord getLIDsByStatus updateEnterpriseRecord getSBR updateSystemRecord

Dynamic API Method Descriptions

activateEnterpriseRecord

Description

This method changes the status of a deactivated enterprise object back to active.

Syntax

void activateEnterpriseRecord(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object to activate.

Returns

None.

Throws

• ProcessingException

• UserException

activateSystemRecord

Description

This method changes the status of a deactivated system object back to active.

Syntax

void activateSystemRecord(String systemCode, String localId)

Parameters

Name Type Description systemCode String The processing code of the system associated with the system record to be activated. localID String The local identifier associated with the system record to be activated.

Returns

None.

Throws

• ProcessingException

• UserException

addSystemRecord

Description

This method adds the system object to the enterprise object associated with the specified EUID.

Syntax

void addSystemRecord(String euid, SystemObjectName sysObjBean)

where ObjectName is the name of the parent object.

Parameters

Name Type Description euid String The EUID of the enterprise object to which you want to add the system object. sysObjBean SystemObjectName The Bean for the system object to be added to the enterprise object.

Returns

None.

Throws

• ProcessingException

• UserException

deactivateEnterpriseRecord

Description

This method changes the status of an active enterprise object to inactive.

Syntax

void deactivateEnterpriseRecord(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object to deactivate.

Returns

None.

Throws

• ProcessingException

• UserException

deactivateSystemRecord

Description

This method changes the status of an active system object to inactive.

Syntax

void deactivateSystemRecord(String systemCode, String localId)

Parameters

Name Type Description systemCode String The system code of the system object to deactivate. localid String The local ID of the system object to deactivate.

Returns

None.

Throws

• ProcessingException

• UserException

executeMatch

executeMatch is one of two methods you can call to process an incoming system object based on the configuration defined for the Manager Service and associated runtime components (the second method is executeMatchUpdate). This process searches for possible matches in the database and contains the logic to add a new record or update existing records in the database. One of the two execute match methods should be used for inserting or updating a record in the database.

The following runtime components configure executeMatch.

• The Query Builder defines the blocking queries used for matching.

• The Threshold file (master.xml) specifies which blocking query to use and specifies matching parameters, including duplicate and match thresholds.

• The pass controller and block picker classes specify how the blocking query is executed.

  ---

  Note - If executeMatch determines that an existing system record will be updated by the incoming record, it replaces the entire existing record with the information in the new record. This could result in loss of data; for example, if the incoming record does not include all address information, existing address information could be lost. To avoid this, use the executeMatchUpdate method instead.

  ---

Syntax

MatchColResult executeMatch(SystemObjectName sysObjBean)

where ObjectName is the name of the parent object.

Parameters

Name Type Description sysObjBean SystemObjectName The Bean for the system object to be added to or updated in the enterprise object.

Returns

A match result object containing the results of the matching process.

Throws

• ProcessingException

• UserException

executeMatchUpdate

Like executeMatch, executeMatchUpdate processes the system object based on the configuration defined for the Manager Service and associated runtime components. It is configured by the same runtime components as executeMatch. One of these two execute match methods should be used for inserting or updating a record in the database.

The primary difference between these two methods is that when executeMatchUpdate finds that an incoming record matches an existing record, only the changed data is updated. With executeMatch, the entire existing record would be replaced by the incoming record. The executeMatchUpdate method differs from executeMatch in the following ways:

• If a partial record is received, executeMatchUpdate only updates fields whose values are different in the incoming record. Unless the clearFieldIndicator field is used, empty or null fields in the incoming record do not update existing values.

• The clearFieldIndicator field can be used to null out specific fields.

• Child objects in the existing record are not deleted if they are not present in the incoming record.

• Child objects in the existing record are updated if the same key field value is found in both the incoming and existing records.

• To allow a child object to be removed from the parent object when using executeMatchUpdate, a new “delete” method is added to each child object bean.

Syntax

MatchColResult executeMatchUpdate(SystemObjectName sysObjBean)

where ObjectName is the name of the parent object.

Parameters

Name Type Description sysObjBean SystemObjectName The Bean for the system object to be added to or updated in the enterprise object.

Returns

A match result object containing the results of the matching process.

Throws

• ProcessingException

• UserException

getEnterpriseRecordByEUID

Description

This method returns the enterprise object associated with the specified EUID.

Syntax

EnterpriseObjectName getEnterpriseRecordByEUID(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object you want to retrieve.

Returns

An enterprise object associated with the specified EUID or null if the enterprise object is not found.

Throws

• ProcessingException

• UserException

getEnterpriseRecordByLID

Description

This method returns the enterprise object associated with the specified system code and local ID pair.

Syntax

EnterpriseObjectName getEnterpriseRecordByLID(String systemCode, String localid)

Parameters

Name Type Description systemCode String The system code of a system associated with the enterprise object to find. localid String A local ID associated with the specified system.

Returns

An enterprise object or null if the enterprise object is not found.

Throws

• ProcessingException

• UserException

getEUID

Description

This method returns the EUID of the enterprise object associated with the specified system code and local ID.

Syntax

String getEUID(String systemCode, String localid)

Parameters

Name Type Description systemCode String A known system code for the enterprise object. localid String The local ID corresponding with the given system.

Returns

A string containing an EUID or null if the EUID is not found.

Throws

• ProcessingException

• UserException

getLIDs

Description

This method retrieves the local ID and system pairs associated with the given EUID.

Syntax

SystemObjectNamePK[] getLIDs(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object whose local ID and system pairs you want to retrieve.

Returns

An array of system object keys (SystemObjectNamePK objects) or null if no results are found.

Throws

• ProcessingException

• UserException

getLIDsByStatus

Description

This method retrieves the local ID and system pairs that are of the specified status and that are associated with the given EUID.

Syntax

SystemObjectNamePK[] getLIDsByStatus(String euid, String status)

Parameters

Name Type Description euid String The EUID of the enterprise object whose local ID and system pairs to retrieve. status String The status of the local ID and system pairs to retrieve.

Returns

An array of system object keys (SystemObjectNamePK objects) or null if no system object keys are found.

Throws

• ProcessingException

• UserException

getSBR

Description

This method retrieves the single best record (SBR) associated with the specified EUID.

Syntax

SBRObjectName getSBR(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object whose SBR you want to retrieve.

Returns

An SBR object or null if no SBR associated with the specified EUID is found.

Throws

• ProcessingException

• UserException

getSystemRecord

Description

This method retrieves the system object associated with the given system code and local ID pair.

Syntax

SystemObjectName getSystemRecord(String systemCode, String localid)

Parameters

Name Type Description systemCode String The system code of the system object to retrieve. localid String The local ID of the system object to retrieve.

Returns

A system object containing the results of the search or null if no system objects are found.

Throws

• ProcessingException

• UserException

getSystemRecordsByEUID

Description

This method returns the active system objects associated with the specified EUID.

Syntax

SystemObjectName[] getSystemRecordsByEUID(String euid)

Parameters

Name Type Description euid String The EUID of the enterprise object whose system objects you want to retrieve.

Returns

An array of system objects associated with the specified EUID.

Throws

• ProcessingException

• UserException

getSystemRecordsByEUIDStatus

Description

This method returns the system objects of the specified status that are associated with the given EUID.

Syntax

SystemObjectName[] getSystemRecordsByEUIDStatus(String euid, String status)

Parameters

Name Type Description euid String The EUID of the enterprise object whose system objects you want to retrieve. status String The status of the system objects you want to retrieve.

Returns

An array of system objects associated with the specified EUID and status, or null if no system objects are found.

Throws

• ProcessingException

• UserException

lookupLIDs

Description

This method first looks up the EUID associated with the specified source system and source local ID. It then retrieves the local ID and system pairs of the specified status that are associated with that EUID and are from the specified destination system. Note that both systems must be of the specified status or an error will occur.

Syntax

SystemObjectNamePK[] lookupLIDs(String sourceSystemCode, String sourceLID, 
String destSystemCode, String status)

Parameters

Name Type Description sourceSystemCode String The system code of the known system and local ID pair. sourceLID String The local ID of the known system and local ID pair. destSystemCode String The system from which the local ID and system pairs to retrieve originated. status String The status of the local ID and system pairs to retrieve.

Returns

An array of system object keys (SystemObjectNamePK objects).

Throws

• ProcessingException

• UserException

lookupPotentialDuplicates

Description

This method returns an array of potential duplicate result records based on the criteria contained in the potential duplicate search object.

Syntax

PotentialDuplicateResult[] lookupPotentialDuplicates(PotentialDuplicateSearchObjectBean pdsoBean)

Parameters

Name Type Description pdsoBean PotentialDuplicateSearchObjectBean An object containing the criteria for a potential duplicate search.

Returns

An array of PotentialDuplicateResult objects representing the matches to a potential duplicate search.

Throws

• ProcessingException

• UserException

• PageException

• RemoteException

mergeEnterpriseRecord

Description

This method merges two enterprise objects, specified by their EUIDs.

Syntax

MergeObjectNameResult mergeEnterpriseRecord(String fromEUID, String toEUID, 
boolean calculateOnly)

Parameters

Name Type Description fromEUID String The EUID of the enterprise object that will not survive the merge. toEUID String The EUID of the enterprise object that will survive the merge. calculateOnly boolean An indicator of whether to commit changes to the database or to simply compute the merge results. Specify false to commit the changes.

Returns

A merge result object containing the results of the merge.

Throws

• ProcessingException

• UserException

mergeSystemRecord

Description

This method merges two system objects, specified by their local IDs, from the specified system. The system objects can belong to a single enterprise object or to two different enterprise objects.

Syntax

MergeObjectNameResult mergeSystemRecord(String systemCode, String sourceLID, 
String destLID, boolean calculateOnly)

Parameters

Name Type Description systemCode String The processing code of the system to which the two system objects belong. sourceLID String The local ID of the system object that will not survive the merge. destLID String The local ID of the system object that will survive the merge. calculateOnly boolean An indicator of whether to commit changes to the database or to simply compute the merge results. Specify false to commit the changes.

Returns

A merge result object containing the results of the merge.

Throws

• ProcessingException

• UserException

searchBlock

Description

This method performs a blocking query against the database using the blocking query specified in the master.xmland the criteria contained in the specified object bean.

Syntax

SearchObjectNameResult[] searchBlock(ObjectNameBean objBean)

Parameters

Name Type Description objBean ObjectNameBean The search criteria for the blocking query.

Returns

An array of search result records.

Throws

• ProcessingException

• UserException

searchExact

Description

This method performs an exact match search using the criteria specified in the object bean. Only records that exactly match the search criteria are returned in the search results object.

Syntax

SearchObjectNameResult[] searchExact(ObjectNameBean objBean)

Parameters

Name Type Description objBean ObjectNameBean The search criteria for the exact match search.

Returns

An array of search result records.

Throws

• ProcessingException

• UserException

searchPhonetic

Description

This method performs search using phonetic values for some of the criteria specified in the object bean. This type of search allows for typographical errors and misspellings.

Syntax

SearchObjectNameResult[] searchPhonetic(ObjectNameBean objBean)

Parameters

Name Type Description objBean ObjectNameBean The search criteria for the phonetic search.

Returns

An array of search result records.

Throws

• ProcessingException

• UserException

transferSystemRecord

Description

This method transfers a system record from one enterprise record to another enterprise record.

Syntax

void transferSystemRecord(String toEUID, String systemCode, String localID)

Parameters

Name Type Description toEUID String The EUID of the enterprise record to which the system record will be transferred. systemCode String The processing code of the system record to transfer. localID String The local ID of the system record to transfer.

Returns

None.

Throws

• ProcessingException

• UserException

updateEnterpriseRecord

Description

This method updates the fields in an existing enterprise object with the values specified in the fields the enterprise object passed in as a parameter. When updating an enterprise object, attempting to change a field that is not updateable will cause an exception. This method does not update the SBR; the survivor calculator updates the SBR once the changes are made to the associated system records.

Syntax

void updateEnterpriseRecord(EnterpriseObjectName eoBean)

Parameters

Name Type Description eoBean EnterpriseObjectName The enterprise object containing the values that will update the existing enterprise object.

Returns

None.

Throws

• ProcessingException

• UserException

updateSystemRecord

Description

This method updates the existing system object in the database with the given system object.

Syntax

void updateSystemRecord(SystemObjectName sysObjBean)

Parameters

Name Type Description sysObjBean SystemObjectName The system object to be updated to the enterprise object.

Returns

None.

Throws

• ProcessingException

• UserException