The following topics list and describe the dynamic OTD methods.
This method changes the status of a deactivated enterprise object back to active.
void activateEnterpriseRecord(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object to activate. |
None.
RemoteException
ProcessingException
UserException
This method changes the status of a deactivated system object back to active.
void activateSystemRecord(String systemCode, String localId) |
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. |
None.
RemoteException
ProcessingException
UserException
This method adds the system object to the enterprise object associated with the specified EUID.
void addSystemRecord(String euid, SystemObjectBean systemObject) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object to which you want to add the system object. |
systemObject |
SystemObjectBean |
The Bean for the system object to be added to the enterprise object. |
None.
RemoteException
ProcessingException
UserException
This method changes the status of an active enterprise object to inactive.
void deactivateEnterpriseRecord(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object to deactivate. |
None.
RemoteException
ProcessingException
UserException
This method changes the status of an active system object to inactive.
void deactivateSystemRecord(String systemCode, String localId) |
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. |
None.
RemoteException
ProcessingException
UserException
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.
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.
MatchColResult executeMatch(SystemObjectBean systemObject) |
Name |
Type |
Description |
---|---|---|
systemObject |
SystemObjectBean |
The Bean for the system object to be added to or updated in the enterprise object. |
A match result object containing the results of the matching process.
RemoteException
ProcessingException
UserException
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 is 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.
MatchColResult executeMatchUpdate(SystemObjectbean systemObject) |
Name |
Type |
Description |
---|---|---|
systemObject |
SystemObjectBean |
The Bean for the system object to be added to or updated in the enterprise object. |
A match result object containing the results of the matching process.
RemoteException
ProcessingException
UserException
This method obtains a handle to the MasterController class, providing access to all of the methods of that class. For more information about the available methods in this class, see the Javadoc provided with Sun Master Index.
MasterController findMasterController() |
None.
A handle to the com.stc.eindex.ejb.master.MasterController class.
None.
This method returns the enterprise object associated with the specified EUID.
EnterpriseObjectName getEnterpriseRecordByEUID(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object you want to retrieve. |
An enterprise object associated with the specified EUID or null if the enterprise object is not found.
RemoteException
ProcessingException
UserException
This method returns the enterprise object associated with the specified system code and local ID pair.
EnterpriseObjectName getEnterpriseRecordByLID(String system, String localid) |
Name |
Type |
Description |
---|---|---|
system |
String |
The system code of a system associated with the enterprise object to find. |
localid |
String |
A local ID associated with the specified system. |
An enterprise object or null if the enterprise object is not found.
RemoteException
ProcessingException
UserException
This method returns the EUID of the enterprise object associated with the specified system code and local ID.
String getEUID(String system, String localid) |
Name |
Type |
Description |
---|---|---|
system |
String |
A known system code for the enterprise object. |
localid |
String |
The local ID corresponding with the given system. |
A string containing an EUID or null if the EUID is not found.
RemoteException
ProcessingException
UserException
This method retrieves the local ID and system pairs associated with the given EUID.
SystemObjectNamePK[] getLIDs(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object whose local ID and system pairs you want to retrieve. |
An array of system object keys (SystemObjectNamePK objects) or null if no results are found.
RemoteException
ProcessingException
UserException
This method retrieves the local ID and system pairs that are of the specified status and that are associated with the given EUID.
SystemObjectNamePK[] getLIDsByStatus(String euid, String status) |
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 you want to retrieve. |
An array of system object keys (SystemObjectNamePK objects) or null if no system object keys are found.
RemoteException
ProcessingException
UserException
This method retrieves the single best record (SBR) associated with the specified EUID.
SBRObjectName getSBR(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object whose SBR you want to retrieve. |
An SBR object or null if no SBR associated with the specified EUID is found.
RemoteException
ProcessingException
UserException
This method retrieves the system object associated with the given system code and local ID pair.
SystemObjectName getSystemRecord(String system, String localid) |
Name |
Type |
Description |
---|---|---|
system |
String |
The system code of the system object to retrieve. |
localid |
String |
The local ID of the system object to retrieve. |
A system object containing the results of the search or null if no system objects are found.
RemoteException
ProcessingException
UserException
This method returns the active system objects associated with the specified EUID.
SystemObjectName[] getSystemRecordsByEUID(String euid) |
Name |
Type |
Description |
---|---|---|
euid |
String |
The EUID of the enterprise object whose system objects you want to retrieve. |
An array of system objects associated with the specified EUID.
RemoteException
ProcessingException
UserException
This method returns the system objects of the specified status that are associated with the given EUID.
SystemObjectName[] getSystemRecordsByEUIDStatus(String euid, String status) |
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. |
An array of system objects associated with the specified EUID and status, or null if no system objects are found.
RemoteException
ProcessingException
UserException
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.
SystemObjectNamePK[] lookupLIDs(String sourceSystem, String sourceLID, String destSystem, String status) |
Name |
Type |
Description |
---|---|---|
sourceSystem |
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. |
destSystem |
String |
The system of origin for the local ID and system pairs you want to retrieve. |
status |
String |
The status of the local ID and system pairs to retrieve. |
An array of system object keys (SystemObjectNamePK objects).
RemoteException
ProcessingException
UserException
This method merges two enterprise objects, specified by their EUIDs.
MergeObjectNameResult mergeEnterpriseRecord(String fromEUID, String toEUID, boolean calculateOnly) |
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. |
A merge result object containing the results of the merge.
RemoteException
ProcessingException
UserException
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.
MergeObjectNameResult mergeSystemRecord(String sourceSystem, String sourceLID, String destLID, boolean calculateOnly) |
Name |
Type |
Description |
---|---|---|
sourceSystem |
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. |
A merge result object containing the results of the merge.
RemoteException
ProcessingException
UserException
This method performs a blocking query against the database using the blocking query specified in the Threshold file and the criteria contained in the specified object bean.
SearchObjectNameResult searchBlock(ObjectNameBean searchCriteria) |
Name |
Type |
Description |
---|---|---|
searchCriteria |
ObjectNameBean |
The search criteria for the blocking query. |
The results of the search.
RemoteException
ProcessingException
UserException
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.
SearchObjectNameResult searchExact(ObjectNameBean searchCriteria) |
Name |
Type |
Description |
---|---|---|
searchCriteria |
ObjectNameBean |
The search criteria for the exact match search. |
The results of the search stored in a SearchObjectNameResult object.
RemoteException
ProcessingException
UserException
This method performs a search using phonetic values for some of the criteria specified in the object bean. This type of search allows for typographical errors and misspellings.
SearchObjectNameResult searchPhonetic(ObjectNameBean searchCriteria) |
Name |
Type |
Description |
---|---|---|
searchCriteria |
ObjectNameBean |
The search criteria for the phonetic search. |
The results of the search.
RemoteException
ProcessingException
UserException
This method transfers a system record from one enterprise record to another enterprise record.
void transferSystemRecord(String toEUID, String systemCode, String localID) |
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. |
None.
RemoteException
ProcessingException
UserException
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.
void updateEnterpriseRecord(EnterpriseObjectName enterpriseObject) |
Name |
Type |
Description |
---|---|---|
enterpriseObject |
EnterpriseObjectName |
The enterprise object containing the values that will update the existing enterprise object. |
None.
RemoteException
ProcessingException
UserException
This method updates the existing system object in the database with the given system object.
void updateSystemRecord(SystemObjectName systemObject) |
Name |
Type |
Description |
---|---|---|
systemObject |
SystemObjectName |
The system object to be updated to the enterprise object. Note – In the method OTD, “Object” in the parameter name is changed to the name of the parent object. For example, if the parent object is “Person”, the name of this parameter will appear as “systemPerson”. |
None.
RemoteException
ProcessingException
UserException