4 Working with the Java API

JAVA API Classes

JAVA API classes provide the methods you need to perform basic data cleansing and processing functions against incoming data, such as performing searches, reviewing potential duplicates, adding and updating records, and merging and unmerging records. The primary class containing these functions is the MasterController class, which includes the executeMatch methods. Several classes support the MasterController class by defining additional objects and functions. Documentation for the JAVA API classes' methods is provided in Javadoc format.

activateEnterpriseObject

Description

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

Syntax

public void activateEnterpriseObject(java.lang.String euid)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

activateSystemObject

Description

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

Syntax

public void activateSystemObject(SystemObjectPK systemKey)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

addSystemObject

Description

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

Syntax

public void addSystemObject(java.lang.String euid, SystemObject sysobj)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

calculatePotentialDuplicates

Description

This method calculates potential duplicates for the specified EUID and transaction ID.

Syntax

public void calculatePotentialDuplicates(java.lang.String euid, java.lang.String transID)

Parameters

Returns

None

Throws

• ProcessingException

calculateSBR

Description

This method calculates a new single best record (SBR) for an enterprise object that is updated.

Syntax

public SBR calculateSBR(EnterpriseObject eo)

Parameters

Returns

Recalculated SBR of the enterprise object.

Throws

• ProcessingException

• UserException

countAssumedMatches

Description

This method counts the number of assumed match records matching the date criteria specified in search object.

Syntax

public int countAssumedMatches(AssumedMatchSearchObject amso)

Parameters

None

Returns

Count of the assumed match records matching the search criteria.

Throws

• ProcessingException

• UserException

countPotentialDuplicates

Description

This method counts the number of potential duplicate records matching the criteria specified in search object.

Syntax

public int countPotentialDuplicates(PotentialDuplicateSearchObject pdso)

Parameters

None

Returns

Count of the potential duplicate records matching the search criteria.

Throws

• ProcessingException

• UserException

createEnterpriseObject

Description

This method creates a new enterprise object to add to the master index database using the information in the specified system object.

Syntax

public EnterpriseObject createEnterpriseObject(SystemObject sysobj)

Parameters

Returns

The enterprise object created from the specified system object.

Throws

• ProcessingException

• UserException

deactivateEnterpriseObject

Description

This method changes the status of an enterprise object from active to inactive and deletes all potential duplicate listings for that object.

Syntax

public void deactivateEnterpriseObject(java.lang.String euid)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

deactivateSystemObject

Description

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

Syntax

public void deactivateSystemObject(SystemObjectPK systemKey)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

deleteSystemObject

Description

This method permanently deletes a system object from its associated enterprise object.

Syntax

public void deleteSystemObject(SystemObjectPK systemKey)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

executeMatch

executeMatch is one of four methods that process a system object based on the configuration defined for the Master Index Manager Service and associated runtime components. This method searches for possible matches in the database, and if it finds a match, it replaces the system object (instead of updating the system object, which is what executeMatchUpdate does).

The following runtime components configure executeMatch.

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

• Threshold configuration specifies which blocking query to use and specifies matching parameters, including duplicate and match thresholds and whether potential duplicates are automatically recalculated for updated records.

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

Syntax

public MatchResult executeMatch(SystemObject sysObj)

Parameters

Returns

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

Throws

• ProcessingException

• UserException

executeMatchDupRecalc

executeMatchDupRecalc is one of four methods that process a system object based on the configuration defined for the Master Index Manager Service and associated runtime components. It is configured by the same components as executeMatch, and is similar to executeMatch but allows you to control whether potential duplicates are recalculated when an object is updated regardless of whether the update mode is set to optimistic or pessimistic.

executeMatchDupRecalc differs from executeMatch in two ways:

• It provides an override flag for the update mode specified in the Threshold configuration file.

• The match result object returned by this method includes an indicator of whether match fields were modified. This helps you determine whether you need to process potential duplicates for this object at a later time.

Syntax

public MatchResult executeMatchDupRecalc(SystemObject sysObj, java.lang.Boolean performPessimistic)

Parameters

Returns

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

Throws

• ProcessingException

• UserException

executeMatchGui

executeMatchGui is identical to executeMatch, but it is only called by the Enterprise Data Manager. It processes a system object based on the configuration defined for the Master Index Manager Service and associated runtime components. This method searches for possible matches in the database, and if it finds a match, it replaces the system object (instead of updating the system object).

The following runtime components configure executeMatchGui:

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

• Threshold configuration 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.

Syntax

public MatchResult executeMatchGui(SystemObject sysObj)

Parameters

Returns

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

Throws

• ProcessingException

• UserException

executeMatchUpdate

executeMatchUpdate is one of four methods that process a system object based on the configuration defined for the Master Index Manager Service and associated runtime components. It is configured by the same components as executeMatch. This method searches for possible matches in the database, and if it finds a match, it updates the system object (instead of replacing the system object, which is what executeMatch does).

The following runtime components configure executeMatchUpdate.

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

• Threshold configuration 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.

Syntax

public MatchResult executeMatchUpdate(SystemObject sysObj)

Parameters

Returns

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

Throws

• ProcessingException

• UserException

executeMatchUpdateDupRecalc

Description

executeMatchUpdateDupRecalc is one of four methods that process a system object based on the configuration defined for the Master Index Manager Service and associated runtime components. It is configured by the same components as executeMatch, and is similar to executeMatchUpdate but allows you to control whether potential duplicates are recalculated when an object is updated regardless of whether the update mode is set to optimistic or pessimistic.

executeMatchUpdateDupRecalc differs from executeMatchUpdate in two ways:

• It provides an override flag for the update mode specified in the Threshold configuration file.

• The match result object returned by this method includes an indicator of whether match fields were modified. This helps you determine whether you need to process potential duplicates for this object at a later time.

Syntax

public MatchResult executeMatchUpdateDupRecalc(SystemObject sysObj, java.lang.Boolean performPessimistic)

Parameters

Returns

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

Throws

• ProcessingException

• UserException

getAssumedMatchThreshold

Description

This method retrieves the Assumed Match threshold.

Syntax

public float getAssumedMatchThreshold()

getConfigurationValue

Description

This method retrieves the configuration for a master controller parameter, such as the EUID length, duplicate threshold, or match threshold.

Syntax

public java.lang.Object getConfigurationValue(java.lang.String param)

Parameters

Returns

An object containing the value of the specified parameter.

Throws

• ProcessingException

• UserException

getDatabaseStatus

Description

This method retrieves the status of the master index database.

Syntax

public java.lang.String getDatabaseStatus()

Parameters

None

Returns

The status of the master index database.

Throws

• ProcessingException

• UserException

getDuplicateThreshold

Description

This method retrieves the potential duplicate threshold.

Syntax

public float getDuplicateThreshold()

getEnterpriseObject

Description

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

Syntax

public EnterpriseObject getEnterpriseObject(java.lang.String euid)

Parameters

Returns

The enterprise object associated with the specified EUID. Returns null if no enterprise object with the specified EUID is found.

Throws

• ProcessingException

• UserException

getEUID

Description

This method returns the EUID associated with the system code and local ID specified in the SystemObjectPK object.

Syntax

public java.lang.String getEUID(SystemObjectPK key)

Parameters

Returns

The EUID associated with the given system object key. Returns null if no results are found.

Throws

• ProcessingException

• UserException

getLinkValues

Description

This method returns a map with (fieldName, actual value for link) for the given EO.

Syntax

public java.util.Map getLinkValues(EnterpriseObject eo)

Parameters

Returns

resultMap map (fieldName, actual value for link) for the given EO.

Throws

• ObjectException

• ConnectionInvalidException

• OPSException

• ProcessingException

getMergeHistory

Description

This method retrieves the history of the merge transactions associated with the specified EUID.

Syntax

public MergeHistoryNode getMergeHistory(java.lang.String euid)

Parameters

Returns

The merge history tree for the specified EUID.

Throws

• ProcessingException

• UserException

getRevisionNumber

Description

This method retrieves the SBR revision number for the specified EUID.

Syntax

public java.lang.Integer getRevisionNumber(java.lang.String euid)

Parameters

Returns

The revision number for the SBR.

Throws

ProcessingException

getSBR

Description

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

Syntax

public SBR getSBR(java.lang.String euid)

Parameters

Returns

The SBR object associated with the specified EUID. Returns null if no SBR associated with the specified EUID is found.

Throws

• ProcessingException

• UserException

getSystemObject

Description

This method returns the system object associated with the system code and local ID contained in the specified SystemObjectPK object.

Syntax

public SystemObject getSystemObject(SystemObjectPK key)

Parameters

Returns

The system object associated with the specified local ID and system code.

Throws

• ProcessingException

• UserException

insertAuditLog

Description

This method inserts an audit log record of a transaction into the database.

Syntax

public void insertAuditLog(AuditDataObject auditObject)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

lookupAssumedMatches

Description

This method returns an iterator of AssumedMatchSummary objects based on the criteria contained in the assumed match search object (AssumedMatchSearchObject class).

Syntax

public AssumedMatchIterator lookupAssumedMatches(AssumedMatchSearchObject obj)

Parameters

Returns

An iterator of search results (AssumedMatchSummary objects).

Throws

• ProcessingException

• UserException

lookupAuditLog

Description

This method looks up an audit log record based on the criteria contained in an audit search object.

Syntax

public AuditIterator lookupAuditLog(AuditSearchObject obj)

Parameters

Returns

An iterator of audit log matches to the given search criteria.

Throws

• ProcessingException

• UserException

lookupPotentialDuplicates

Description

This method returns an iterator of PotentialDuplicateSummary objects based on the criteria contained in the potential duplicate search object (PotentialDuplicateSearchObject class).

Syntax

public PotentialDuplicateIterator lookupPotentialDuplicates(PotentialDuplicateSearchObject obj)

Parameters

Returns

An iterator of search results (PotentialDuplicateSummary objects).

Throws

• ProcessingException

• UserException

lookupSystemDefinition

Description

This method retrieves the attributes of an external system from the master index database based on the system code.

Syntax

public SystemDefinition lookupSystemDefinition(java.lang.String systemCode)

Parameters

Returns

A set of system attributes for the system identified the given system code.

Throws

ProcessingException

lookupSystemDefinitions

Description

This method retrieves the attributes of an external system from the master index database, such as the system code, masking flags, local ID format and so on.

Syntax

public SystemDefinition[] lookupSystemDefinitions()

Parameters

None

Returns

An array of system attributes.

Throws

ProcessingException

lookupSystemObjectPKs

Description

This method returns an array of all system objects associated with the specified EUID.

Syntax

public SystemObjectPK[] lookupSystemObjectPKs(java.lang.String euid)

Parameters

Returns

An array of system objects associated with the specified EUID.

Throws

• ProcessingException

• UserException

lookupSystemObjects

Description

This method looks up the active system objects associated with the specified EUID.

Syntax

public SystemObject[] lookupSystemObjects(java.lang.String euid)

Parameters

Returns

An array of system objects that are associated with the specified EUID.

Throws

• ProcessingException

• UserException

lookupTransaction

Description

This method returns a transaction summary for the transaction associated with the specified transaction number.

Syntax

public TransactionSummary lookupTransaction(java.lang.String transId)

Parameters

Returns

The transaction summary for the specified transaction ID.

Throws

• ProcessingException

• UserException

lookupTransactions

Description

This method returns an array of transaction summaries based on the search criteria contained in the specified transaction search object.

Syntax

public TransactionIterator lookupTransactions(TransactionSearchObject obj)

Parameters

Returns

An array of transaction summaries matching the given search criteria.

Throws

• ProcessingException

• UserException

mergeEnterpriseObject

Description

This method merges two enterprise objects based on the specified EUID and enterprise object.

Syntax

public MergeResult mergeEnterpriseObject(java.lang.String sourceEUID, EnterpriseObject destinationEO, boolean calculateOnly)

Parameters

Returns

The results of the merge operation.

Throws

• ProcessingException

• UserException

mergeMultipleEnterpriseObjects

Description

This method merges multiple enterprise objects based on the specified EUIDs and enterprise object.

Syntax

public MergeResult[] mergeMultipleEnterpriseObjects(java.lang.String[] sourceEUIDs, EnterpriseObject destinationEO, java.lang.String[] srcRevisionNumbers, java.lang.String destRevisionNumber, boolean calculateOnly)

Parameters

Returns

The results of the merge operation.

Throws

• ProcessingException

• UserException

mergeSystemObject

Description

Merges two system objects from the specified system. The system objects may belong to a single enterprise object or to two different enterprise objects.

Syntax

public MergeResult mergeSystemObject(java.lang.String systemCode, java.lang.String sourceLID, java.lang.String destLID, boolean calculateOnly)

Parameters

Returns

The results of the merge operation.

Throws

• ProcessingException

• UserException

previewUndoAssumedMatch

Description

This method previews the undo assumed match.

Syntax

public EnterpriseObject previewUndoAssumedMatch(java.lang.String assumedMatchId)

Parameters

Returns

EUID of new EO

Throws

• ProcessingException

• UserException

resolvePotentialDuplicate

Description

This method flags a potential duplicate pair with Resolved or Auto Resolved status. If resolved, the pair can be marked as potential duplicates again during a future transaction. If auto-resolved, the pair is permanently flagged as resolved.

Syntax

public void resolvePotentialDuplicate(java.lang.String id, boolean autoResolve)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

searchEnterpriseObject

Description

This method returns an iterator of enterprise objects that match the specified search criteria and options.

Syntax

public EOSearchResultIterator searchEnterpriseObject(EOSearchCriteria criteria, EOSearchOptions searchOptions)

Parameters

Returns

An iterator containing the results of the query.

Throws

• ProcessingException

• UserException

transferSystemObject

Description

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

Syntax

public void transferSystemObject(java.lang.String toEUID, SystemObjectPK systemKey)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

undoAssumedMatch

Description

This method reverses an assumed match transaction, unmerging the two objects that were matched and creating a new enterprise object for the record that caused the assumed match. Potential duplicates are calculated for the new enterprise object.

Syntax

public java.lang.String undoAssumedMatch(java.lang.String assumedMatchId)

Parameters

Returns

The EUID of the newly created enterprise object resulting from the reversing assumed match.

Throws

• ProcessingException

• UserException

unmergeEnterpriseObject

Description

This method unmerges the two enterprise objects that were involved in the most recent merge transaction for the specified EUID. When the calculateOnly is set to true, the unmerge results is calculated, but the changes are not committed to the database.

Syntax

public MergeResult unmergeEnterpriseObject(java.lang.String euid, boolean calculateOnly)

Parameters

Returns

The result of the unmerge transaction.

Throws

• ProcessingException

• UserException

unmergeSystemObject

Description

This method unmerges the two system objects that were involved in the most recent merge transaction for the specified local ID. When the calculateOnly is set to true, the unmerge results is computed, but the changes are not committed to the database.

Syntax

public MergeResult unmergeSystemObject(java.lang.String systemCode, java.lang.String sourceLID, java.lang.String destLID, boolean calculateOnly)

Parameters

Returns

The result of the unmerge transaction.

Throws

• ProcessingException

• UserException

unresolvePotentialDuplicate

Description

This method changes the status of a resolved or auto-resolved potential duplicate record pair back to unresolved and places the records back in the potential duplicate listing.

Syntax

public void unresolvePotentialDuplicate(java.lang.String id)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

updateEnterpriseDupRecalc

Description

This method updates the database to reflect the new values of the specified enterprise object. This method is similar to updateEnterpriseObject but it allows you to control whether potential duplicate recalculation is performed when an enterprise object is updated, regardless of whether the update mode is set to optimistic or pessimistic.

This method differs from updateEnterpriseObject in two ways:

• It provides an override flag for the update mode specified in the Threshold configuration file.

• The update result object returned by this method includes an indicator of whether match fields were modified. This helps you determine whether you need to process potential duplicates for this object at a later time.

Syntax

public UpdateResult updateEnterpriseDupRecalc(EnterpriseObject eo, java.lang.Boolean performPessimistic)

Parameters

Returns

The UpdateResult object created from the update.

Throws

• ProcessingException

• UserException

updateEnterpriseObject

Description

This method updates the database to reflect the new values of the specified enterprise object. If the enterprise object is deactivated during the update, potential duplicates are deleted for that object. If the enterprise object is still active, was changed during the transaction, and the update mode is set to pessimistic, the application checks whether any key fields were updated in the SBR of the enterprise object. If key fields were updated, potential duplicates are recalculated.

Syntax

public void updateEnterpriseObject(EnterpriseObject eo)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

updateSBR

Description

This method updates SBR by collecting the values from MAP to the SBR that specified by EUID.

Syntax

public EnterpriseObject updateSBR(java.util.Map mapSystems, EnterpriseObject eo, boolean removalFlag)

Parameters

Returns

None

Throws

• ProcessingException

• UserException

updateSystemObject

Description

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

Syntax

public void updateSystemObject(SystemObject sysobj)

Parameters

Returns

None

Throws

• ProcessingException

• UserException