Working with the Master Index Java API (Repository)
Sun Master Index provides several Java classes and methods to use to transform and process data in a master index project. The master index API is specifically designed to help you maintain the integrity of the data in the database by providing specific methods for updating, adding, and merging records in the database.
The following topics provide information about the master index API and describe the dynamic API:
Master Index Java Class Types (Repository)
Sun Master Index provides a set of static API classes that can be used with any object structure and any Sun master index application. Sun Master Index also generates several dynamic API classes that are specific to the object structure of each master index application. The dynamic classes contain similar methods, but the number and names of methods change depending on the object structure. In addition, several methods are generated in an OTD for use in external system Collaborations and another set of methods is generated for use within an Business Process. For detailed information about the static classes and methods, see the Javadocs.
The following topics provide additional information about the different types of Java classes:
Static Master Index Java Classes (Repository)
Static classes provide the methods you need to perform basic data cleansing 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 method. Several classes support the MasterController class by defining additional objects and functions. Documentation for the static methods is provided in Javadoc format. The static classes are listed and described in the Javadocs provided with Sun Master Index.
Dynamic Master Index Object Classes (Repository)
When you generate a master index project, several dynamic methods are created that are specific to the object structure defined for the master index application. This includes classes that define each object in the object structure and that allow you to work with the data in each object. If the object structure is modified, regenerating the project updates the dynamic methods for the new structure.
Dynamic OTD Methods
When you generate a master index project, a method OTD is created that contains Java methods to help you define how records are processed into the master index database from external systems. Like the dynamic object classes, these methods are based on the object structure. They rely on the dynamic object classes to create the objects in the master index application and to define and retrieve field values for those objects. Regenerating the master index application updates the methods to reflect any changes to the object structure.
Dynamic Business Process Methods
When you generate a master index project, several methods are listed under the method OTD folder that are designed for use within a Business Process. These methods are a subset of the master index API that can be used to query a master index database using a web-based interface. As with the dynamic OTD methods, the Business Process methods are also based on the defined object structure. Regenerating a project updates these methods to reflect any changes to the object structure.
Dynamic Master Index Object Classes (Repository)
Several dynamic classes are generated for each master index application for use in Collaborations. One class is created for each parent and child object defined in the object structure.
The following topics list and describe the dynamic object classes:
Master Index Parent Object Classes (Repository)
A Java class is created to represent the parent object defined in the object definition of the master index application. The methods in this class provide the ability to create a parent object and to set or retrieve the field values for that object.
The name of the parent object class is the same as the name of each parent object, with the word “Object” appended. For example, if the parent object in your object structure is “Person”, the name of the parent class is “PersonObject”. The methods in this class include a constructor method for the parent object, and get and set methods for each field defined for the parent object. Most methods are named based on the name of the parent object and the fields and child objects defined for that object. In the following methods described for the parent object, ObjectName indicates the name of the parent object, Child indicates the name of a child object, and Field indicates the name of a field defined for the parent object.
Definition
class ObjectNameObject |
Methods
ObjectNameObject
Description
This is the user-defined object name class for the parent object. You can instantiate this class to create a new instance of the parent object class.
Syntax
new ObjectNameObject()
Parameters
None.
Returns
An instance of the parent object.
Throws
ObjectException
addChild
Description
This method associates a new child object with the parent object. The new child object is of the type specified in the method name. For example, to associate a new address object with a parent object, call addAddress.
Syntax
void addChild(ChildObject child)
Note –
The type of object passed as a parameter depends on the child object to associate with the parent object. For example, the syntax for associating an address object is as follows:
void addAddress(AddressObject address) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
child |
ChildObject |
A child object to associate with the parent object. The name and type of the parameter is specified by the child object name. |
Returns
None.
Throws
ObjectException
addSecondaryObject
Description
This method associates a new child object with the parent object. The object node passed as the parameter defines the child object type.
Syntax
void addSecondaryObject(ObjectNode obj) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
obj |
ObjectNode |
An ObjectNode representing the child object to associate with the parent object. |
Returns
None.
Throws
SystemObjectException
copy
Description
This method copies the structure and field values of the specified object node.
Syntax
ObjectNode copy() |
Parameters
None.
Returns
A copy of the object node.
Throws
ObjectException
dropSecondaryObject
Description
This method removes a child object associated with the parent object (in the memory copy of the object). The object node passed in as the parameter defines the child object type. Use this method to remove a child object before it has been committed to the database. This method is similar to ObjectNode.removeChild. Use ObjectNode.deleteChild to remove the child object permanently from the database.
Syntax
void dropSecondaryObject(ObjectNode obj) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
obj |
ObjectNode |
An ObjectNode representing the child object to drop from the parent object. |
Returns
None.
Throws
SystemObjectException
getObjectNameId
Description
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
Syntax
String getObjectNameId() |
Parameters
None.
Returns
A string containing the unique ID of the parent object.
Throws
ObjectException
getChild
Description
This method retrieves all child objects associated with the parent object that are of the type specified in the method name. For example, to retrieve all address objects associated with a parent object, call getAddress.
Syntax
Collection getChild() |
Parameters
None.
Returns
A collection of child objects of the type specified in the method name.
Throws
None.
getField
Description
This method retrieves the value of the field specified in the method name. Each getter method is named according to the fields defined for the parent object. For example, if the parent object contains a field named FirstName, the getter method for this field is named getFirstName.
Syntax
String getField() |
Note –
The syntax for the getter methods depends on the type of data specified for the field in the object structure. For example, the getter method for a date field would have the following syntax:
Date getField |
Parameters
None.
Returns
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
Throws
ObjectException
getChildTags
Description
This method retrieves a list of the names of all child object types defined for the object structure.
Syntax
ArrayList getChildTags() |
Parameters
None.
Returns
An array of child object names.
Throws
None.
getMetaData
Description
This method retrieves the metadata for the parent object.
Syntax
AttributeMetaData getMetaData() |
Parameters
None.
Returns
An AttributeMetaData object containing the parent object’s metadata.
Throws
None.
getSecondaryObject
Description
This method retrieves all child objects that are associated with the parent object and are of the specified type.
Syntax
Collection getSecondaryObject(String type) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
type |
String |
The child type of the objects to retrieve. |
Returns
A collection of child objects of the specified type.
Throws
SystemObjectException
isAdded
Description
This method retrieves the value of the “add flag” for the parent object. The add flag indicates whether the object will be added.
Syntax
String isAdded() |
Parameters
None.
Returns
A Boolean value indicating whether the add flag is set to true or false.
Throws
ObjectException
isRemoved
Description
This method retrieves the value of the “remove flag” for the parent object. The remove flag indicates whether the object will be removed.
Syntax
String isRemoved() |
Parameters
None.
Returns
A Boolean value indicating whether the remove flag is set to true or false.
Throws
ObjectException
isUpdated
Description
This method retrieves the value of the “update flag” for the parent object. The update flag indicates whether the object will be updated.
Syntax
String isUpdated() |
Parameters
None.
Returns
A Boolean value indicating whether the update flag is set to true or false.
Throws
ObjectException
setObjectNameId
Description
This method sets the value of the ObjectNameId field in the parent object.
Syntax
void setObjectNameId(Object value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
Object |
An object containing the value of the ObjectNameId field. |
Returns
None.
Throws
ObjectException
setField
Description
This method sets the value of the field specified in the method name. Each setter method is named according to the fields defined for the parent object. For example, if the parent object contains a field named “DateOfBirth”, the setter method for this field is named setDateOfBirth. A setter method is created for each field in the parent object, including any fields containing standardized or phonetic data.
Syntax
void setField(Object value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
Object |
An object containing the value of the field specified by the method name. |
Returns
None.
Throws
ObjectException
setAddFlag
Description
This method sets the “add flag” of the parent object. The add flag indicates whether the object will be added.
Syntax
void setAddFlag(boolean flag) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
flag |
Boolean |
An indicator of whether the add flag is set to true or false. |
Returns
None.
Throws
None.
setRemoveFlag
Description
This method sets the “remove flag” of the parent object. The remove flag indicates whether the object will be removed.
Syntax
void setRemoveFlag(boolean e) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
e |
Boolean |
An indicator of whether the remove flag is set to true or false. |
Returns
None.
Throws
None.
setUpdateFlag
Description
This method sets the “update flag” of the parent object. The update flag indicates whether the object will be updated.
Syntax
void setUpdateFlag(boolean flag) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
flag |
Boolean |
An indicator of whether the update flag is set to true or false. |
Returns
None.
Throws
None.
structCopy
Description
This method copies the structure of the specified object node.
Syntax
ObjectNode structCopy() |
Parameters
None.
Returns
A copy of the structure of the object node.
Throws
ObjectException
Master Index Child Object Classes (Repository)
One Java class is created for each child object defined in the object definition of the master index application. If the object definition contains three child objects, three child object classes are created. The methods in these classes provide the ability to create the child objects and to set or retrieve the field values for those objects.
The name of each child object class is the same as the name of the child object, with the word “Object” appended. For example, if a child object in your object structure is named “Address”, the name of the corresponding child class is AddressObject. The methods in these classes include a constructor method for the child object, and get and set methods for each field defined for the child object. Most methods are named based on the name of the child object and the fields defined for that object. In the methods listed below, Child indicates the name of the child object and Field indicates the name of each field defined for that object.
Definition
class ChildObject |
Methods
ChildObject
Description
This method represents the child object class. This class can be instantiated to create a new instance of a child object class.
Syntax
new ChildObject() |
Parameters
None.
Returns
An instance of the child object.
Throws
ObjectException
copy
Description
This method copies the structure and field values of the specified object node.
Syntax
ObjectNode copy() |
Parameters
None.
Returns
A copy of the object node.
Throws
ObjectException
getChildId
Description
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
Syntax
String getChildId() |
Parameters
None.
Returns
A string containing the unique ID of the child object.
Throws
ObjectException
getField
Description
This method retrieves the value of the field specified in the method name. Each getter method is named according to the fields defined for the child object. For example, if the child object contains a field named “TelephoneNumber”, the getter method for this field is named getTelephoneNumber. A getter method is created for each field in the object, including fields that store standardized or phonetic data.
Syntax
String getField() |
Note –
The syntax for the getter methods depends on the type of data specified for the field in the object structure. For example, the getter method for a date field would have the following syntax:
Date getField |
Parameters
None.
Returns
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
Throws
ObjectException
getMetaData
Description
This method retrieves the metadata for the child object.
Syntax
AttributeMetaData getMetaData() |
Parameters
None.
Returns
An AttributeMetaData object containing the child object’s metadata.
Throws
None.
getParentTag
Description
This method retrieves the name of the parent object of the child object.
Syntax
String getParentTag() |
Parameters
None.
Returns
A string containing the name of the parent object.
Throws
None.
setChildId
Description
This method sets the value of the ChildId field in the child object.
Syntax
void setChildId(Object value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
Object |
An object containing the value of the ChildId field. |
Returns
None.
Throws
ObjectException
setField
Description
This method sets the value of the field specified in the method name. Each setter method is named according to the fields defined for the parent object. For example, if the parent object contains a field named “CompanyName”, the setter method for this field is named setCompanyName.
Syntax
void setField(Object value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
Object |
An object containing the value of the field specified by the method name. |
Returns
None.
Throws
ObjectException
structCopy
Description
This method copies the structure of the specified object node.
Syntax
ObjectNode structCopy() |
Parameters
None.
Returns
A copy of the structure of the object node.
Throws
ObjectException
Dynamic Master Index OTD Methods (Repository)
A set of Java methods are created in an OTD for use in the master index Collaborations. These methods wrap static Java API methods, allowing them to work with the dynamic object classes. Many OTD methods return objects of the dynamic object type, or they use these objects as parameters. In the following methods described for the OTD methods, ObjectName indicates the name of the parent object.
Dynamic Master Index OTD Methods (Repository)
The following topics list and describe the dynamic OTD methods.
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
-
RemoteException
-
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
-
RemoteException
-
ProcessingException
-
UserException
addSystemRecord
Description
This method adds the system object to the enterprise object associated with the specified EUID.
Syntax
void addSystemRecord(String euid, SystemObjectBean systemObject) |
Parameters
|
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. |
Returns
None.
Throws
-
RemoteException
-
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
-
RemoteException
-
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
-
RemoteException
-
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(SystemObjectBean systemObject) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
systemObject |
SystemObjectBean |
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
-
RemoteException
-
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 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.
Syntax
MatchColResult executeMatchUpdate(SystemObjectbean systemObject) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
systemObject |
SystemObjectBean |
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
-
RemoteException
-
ProcessingException
-
UserException
findMasterController
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.
Syntax
MasterController findMasterController() |
Parameters
None.
Returns
A handle to the com.stc.eindex.ejb.master.MasterController class.
Throws
None.
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
-
RemoteException
-
ProcessingException
-
UserException
getEnterpriseRecordByLID
Description
This method returns the enterprise object associated with the specified system code and local ID pair.
Syntax
EnterpriseObjectName getEnterpriseRecordByLID(String system, String localid) |
Parameters
|
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. |
Returns
An enterprise object or null if the enterprise object is not found.
Throws
-
RemoteException
-
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 system, String localid) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
system |
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
-
RemoteException
-
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
-
RemoteException
-
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 you want to retrieve. |
Returns
An array of system object keys (SystemObjectNamePK objects) or null if no system object keys are found.
Throws
-
RemoteException
-
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
-
RemoteException
-
ProcessingException
-
UserException
getSystemRecord
Description
This method retrieves the system object associated with the given system code and local ID pair.
Syntax
SystemObjectName getSystemRecord(String system, String localid) |
Parameters
|
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. |
Returns
A system object containing the results of the search or null if no system objects are found.
Throws
-
RemoteException
-
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
-
RemoteException
-
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
-
RemoteException
-
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 sourceSystem, String sourceLID, String destSystem, String status) |
Parameters
|
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. |
Returns
An array of system object keys (SystemObjectNamePK objects).
Throws
-
RemoteException
-
ProcessingException
-
UserException
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
-
RemoteException
-
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 sourceSystem, String sourceLID, String destLID, boolean calculateOnly) |
Parameters
|
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. |
Returns
A merge result object containing the results of the merge.
Throws
-
RemoteException
-
ProcessingException
-
UserException
searchBlock
Description
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.
Syntax
SearchObjectNameResult searchBlock(ObjectNameBean searchCriteria) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
searchCriteria |
ObjectNameBean |
The search criteria for the blocking query. |
Returns
The results of the search.
Throws
-
RemoteException
-
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 searchCriteria) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
searchCriteria |
ObjectNameBean |
The search criteria for the exact match search. |
Returns
The results of the search stored in a SearchObjectNameResult object.
Throws
-
RemoteException
-
ProcessingException
-
UserException
searchPhonetic
Description
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.
Syntax
SearchObjectNameResult searchPhonetic(ObjectNameBean searchCriteria) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
searchCriteria |
ObjectNameBean |
The search criteria for the phonetic search. |
Returns
The results of the search.
Throws
-
RemoteException
-
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
-
RemoteException
-
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 enterpriseObject) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
enterpriseObject |
EnterpriseObjectName |
The enterprise object containing the values that will update the existing enterprise object. |
Returns
None.
Throws
-
RemoteException
-
ProcessingException
-
UserException
updateSystemRecord
Description
This method updates the existing system object in the database with the given system object.
Syntax
void updateSystemRecord(SystemObjectName systemObject) |
Parameters
|
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”. |
Returns
None.
Throws
-
RemoteException
-
ProcessingException
-
UserException
Dynamic Business Process Methods (Repository)
A set of Java methods are created in the master index application for use in Business Processes. These methods include a subset of the dynamic OTD methods, which are documented above. Many of these methods return objects of the dynamic object type or they use these objects as parameters. In the descriptions for these methods, ObjectName indicates the name of the parent object.
The following methods are available for Business Processes. They are described in the previous section, Dynamic Master Index OTD Methods (Repository).
Master Index Helper Classes (Repository)
Helper classes include objects that can be passed as parameters to an OTD method or a Business Process method. They also include the methods that you can access through the systemObjectName variable in client Collaborations or Business Processes (where ObjectName is the name of a parent object. The helper classes include:
SystemObjectName Master Index Class (Repository)
In order to run executeMatch or executeMatchUpdate in a Java Collaboration or Business Process, you must define a variable of the class type SystemObjectName, where ObjectName is the name of a parent object. This class is passed as a parameter to the execute match methods. The class contains a constructor method and several get and set methods for system fields. It also includes one field that specifies the value of the clear field character (for more information, see ClearFieldIndicator Field). In the methods described in this section, ObjectName indicates the name of the parent object, Child indicates the name of a child object, and Field indicates the name of a field defined for the parent object.
Definition
class SystemObjectName |
Fields
Methods
Inherited Methods
The following methods are inherited from java.lang.Object.
-
equals
-
hashcode
-
notify
-
notifyAll
-
toString
-
wait()
-
wait(long arg)
-
wait(long timeout, int nanos)
ClearFieldIndicator Field
The ClearFieldIndicator field allows you to specify whether to treat a field in the parent object as null when performing an update from an external system. When an update is performed in the master index application, empty fields typically do not overwrite the value of an existing field. You can specify to nullify a field that already has an existing value in the master index application by entering an indicator in that field. This indicator is specified by the ClearFieldIndicator field. By default, the ClearFieldIndicator field is set to double-quotes (“”), so if a field is set to double-quotes, that field will be blanked out. If you do not want to use this feature, set the clear field indicator to null.
SystemObjectName
Description
This method is the user-defined system class for the parent object. You can instantiate this class to create a new instance of the system class.
Syntax
new SystemObjectName() |
Parameters
None.
Returns
An instance of the SystemObjectName class.
Throws
ObjectException
getClearFieldIndicator
Description
This method retrieves the value of the ClearFieldIndicator field.
Syntax
Object getClearFieldIndicator() |
Parameters
None.
Returns
An object containing the value of the ClearFieldIndicator field.
Throws
None.
getField
Description
This method retrieves the value of the specified system field. There are getter methods for the following fields: LocalId, SystemCode, Status, CreateDateTime, CreateFunction, and CreateUser.
Syntax
String getField() |
or
Date getField() |
Parameters
None.
Returns
The value of the specified field. The type of value returned depends on the field from which the value was retrieved.
Throws
ObjectException
getObjectName
Description
This method retrieves the parent object Java Bean for the system record.
Syntax
ObjectNameBean getObjectName() |
Parameters
None.
Returns
A Java Bean containing the parent object.
Throws
None.
setClearFieldIndicator
Description
This method sets the value of the clear field character (in the ClearFieldIndicator field). By default, this is set to double quotes (“”).
Syntax
void setClearFieldIndicator(String value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
String |
The value that should be entered into a field to indicate that any existing values should be replaced with null. |
Returns
None.
Throws
None.
setField
Description
This method sets the value of the specified system field. There are setter methods for the following fields: LocalId, SystemCode, Status, CreateDateTime, CreateFunction, and CreateUser.
Syntax
void setField(value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
varies |
The value to set in the specified field. The type of value depends on the field into which the value is being set. |
Returns
None.
Throws
ObjectException
setObjectName
Description
This method sets the parent object Java Bean for the system record.
Syntax
void setObjectName(ObjectNameBean object) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
object |
ObjectNameBean |
The Java Bean for the parent object. |
Returns
None.
Throws
ObjectException
Master Index Parent Beans (Repository)
A Java Bean is created to represent each parent object defined in the object definition of the master index application. The methods in these classes provide the ability to create a parent object Bean and to set or retrieve the field values for that object Bean.
The name of each parent object Bean class is the same as the name of each parent object, with the word “Bean” appended. For example, if a parent object in your object structure is “Person”, the name of the associated parent Bean class is “PersonBean”. The methods in this class include a constructor method for the parent object Bean, and get and set methods for each field defined for the parent object. Most methods are named based on the name of the parent object and the fields and child objects defined for that object. In the methods described in this section, ObjectName indicates the name of the parent object, Child indicates the name of a child object, and Field indicates the name of a field defined for the parent object.
Definition
final class ObjectNameBean |
Methods
Inherited Methods
The following methods are inherited from java.lang.Object.
-
equals
-
hashcode
-
notify
-
notifyAll
-
toString
-
wait()
-
wait(long arg)
-
wait(long timeout, int nanos)
ObjectNameBean
Description
This method is the user-defined object Bean class. You can instantiate this class to create a new instance of the parent object Bean class.
Syntax
new ObjectNameBean() |
Parameters
None.
Returns
An instance of the parent object Bean.
Throws
ObjectException
countChild
Description
This method returns the total number of child objects contained in a system object. The type of child object is specified by the method name (such as Phone or Address).
Syntax
int countChild() |
Parameters
None.
Returns
An integer indicating the number of child objects in a collection.
Throws
None.
countChildren
Description
This method returns a count of the total number of child objects belonging to a system object.
Syntax
int countChildren() |
Parameters
None.
Returns
An integer representing the total number of child objects.
Throws
None.
countChildren
Description
This method returns a count of the total number of child objects of a specific type that belong to a system object.
Syntax
int countChildren(String type) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
type |
String |
The type of child object to count, such as Phone or Address. |
Returns
An integer representing the total number of child objects of the specified type.
Throws
None.
deleteChild
Description
This method removes the specified child object from the system object. The type of child object to remove is specified by the name of the method, and the specific child object to remove is specified by its unique identification code assigned by the master index application.
Syntax
void deleteChild(String ChildId) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
ChildId |
String |
The unique identification code of the child object to delete. |
Returns
None.
Throws
ObjectException
getChild
Description
This method retrieves an array of child object Beans. Each getter method is named according to the child objects defined for the parent object. For example, if the parent object contains a child object named “Address”, the getter method for this field is named getAddress. A getter method is created for each child object in the parent object.
Syntax
ChildBean[] getChild() |
Parameters
None.
Returns
An array of Java Beans containing the type of child objects specified by the method name.
Throws
None.
getChild
Description
This method retrieves a child object Bean based on its index in a list of child objects. Each getter method is named according to the child objects defined for the parent object. For example, if the parent object contains a child object named “Address”, the getter method for this field is named getAddress. A getter method is created for each child object in the parent object.
Syntax
ChildBean getChild(int i) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
i |
int |
The index of the child object to retrieve from a list of child objects. |
Returns
A Java Bean containing the child object specified by the index value. The method name indicates the type of child object returned.
Throws
ObjectException
getField
Description
This method retrieves the value of the field specified in the method name. Each getter method is named according to the fields defined for the parent object. For example, if the parent object contains a field named “FirstName”, the getter method for this field is named getFirstName.
Syntax
String getField() |
Note –
The syntax for the getter methods depends on the type of data specified for the field in the object structure. For example, the getter method for a date field would have the following syntax:
Date getField |
Parameters
None.
Returns
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
Throws
ObjectException
getObjectNameId
Description
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
Syntax
String getObjectNameId() |
Parameters
None.
Returns
A string containing the unique ID of the parent object.
Throws
ObjectException
setChild
Description
This method adds a child object to the system object.
Syntax
void setChild(int index, ChildBean child) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
index |
integer |
The index number for the new child object. |
|
child |
ChildBean |
The Java Bean containing the child object to add. |
Returns
None.
Throws
None.
setChild
Description
This method adds an array of child objects of one type to the system object.
Syntax
void setChild(ChildBean[] children) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
children |
ChildBean[] |
The array of child objects to add. |
Returns
None.
Throws
None.
setField
Description
This method sets the value of the field specified in the method name. Each setter method is named according to the fields defined for the parent object. For example, if the parent object contains a field named “DateOfBirth”, the setter method for this field is named setDateOfBirth. A setter method is created for each field in the parent object, including any fields containing standardized or phonetic data.
Syntax
void setField(value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
varies |
The value of the field specified by the method name. The type of value depends on the field being populated. |
Returns
None.
Throws
ObjectException
setObjectNameId
Description
This method sets the value of the ObjectNameId field in the parent object.
Note –
This ID is set internally by the master index application. Do not set this field manually.
Syntax
void setObjectNameId(String value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
String |
The value of the ObjectNameId field. |
Returns
None.
Throws
ObjectException
Master Index Child Beans (Repository)
A Java Bean is created to represent each child object defined in the object definition of the master index application. The methods in these classes provide the ability to create a child object Bean and to set or retrieve the field values for that object Bean.
The name of each child object Bean class is the same as the name of each child object, with the word “Bean” appended. For example, if a child object in your object structure is named “Address”, the name of the corresponding child class is AddressBean. The methods in this class include a constructor method for the child object Bean, and get and set methods for each field defined for the child object. Most methods have dynamic names based on the name of the child object and the fields defined for that object. In the following methods, Child indicates the name of a child object and Field indicates the name of a field defined for the child object.
Definition
final class ChildBean |
Methods
Inherited Methods
The following methods are inherited from java.lang.Object.
-
equals
-
hashcode
-
notify
-
notifyAll
-
toString
-
wait()
-
wait(long arg)
-
wait(long timeout, int nanos)
ChildBean
Description
This method is the user-defined object Bean class. You can instantiate this class to create a new instance of the child object Bean class.
Syntax
new ChildBean() |
Parameters
None.
Returns
An instance of the child object Bean.
Throws
ObjectException
delete
Description
This method removes the child object from the object being processed. This is used with the executeMatchUpdate function to update a system object by deleting one of the child objects from the object being processed.
Syntax
void delete() |
Parameters
None.
Returns
None.
Throws
ObjectException
getField
Description
This method retrieves the value of the field specified in the method name. Each getter method is named according to the fields defined for the child object. For example, if the child object contains a field named “ZipCode”, the getter method for this field is named getZipCode.
Syntax
String getField() |
Note –
The syntax for the getter methods depends on the type of data specified for the field in the object structure. For example, the getter method for a date field would have the following syntax:
Date getField |
Parameters
None.
Returns
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
Throws
ObjectException
getChildId
Description
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
Syntax
String getChildId() |
Parameters
None.
Returns
A string containing the unique ID of the child object.
Throws
ObjectException
setField
Description
This method sets the value of the field specified in the method name. Each setter method is named according to the fields defined for the child object. For example, if the child object contains a field named “Address”, the setter method for this field is named setAddress. A setter method is created for each field in the child object, including any fields containing standardized or phonetic data.
Syntax
void setField(value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
varies |
The value of the field specified by the method name. The type of value depends on the data type of the field being populated. |
Returns
None.
Throws
ObjectException
setChildId
Description
This method sets the value of the ChildId field in the child object.
Note –
This ID is set internally by the master index application. Do not set this field manually.
Syntax
void setChildId(String value) |
Parameters
|
Name |
Type |
Description |
|---|---|---|
|
value |
String |
The value of the ChildId field. |
Returns
None.
Throws
ObjectException
DestinationEO Master Index Class (Repository)
This class represents an enterprise object involved in a merge. This is the enterprise object whose EUID was kept in the final merge result record. A DestinationEO object is used when unmerging two enterprise objects.
Definition
class DestinationEO |
Methods
getEnterpriseObjectName
Description
This method retrieves the surviving enterprise object from a merge transaction in order to allow the records to be unmerged.
Syntax
EnterpriseObjectName getEnterpriseObjectName() |
where ObjectName is the name of the parent object.
Parameters
None.
Returns
The surviving enterprise object from a merge transaction.
Throws
ObjectException
SearchObjectNameResult Master Index Class (Repository)
This class represents the results of a search. A SearchObjectNameResult object (where ObjectName is the name of the parent object) is returned as a result of a call to searchBlock, searchExact, or searchPhonetic.searchBlock
Definition
class SearchObjectNameResult |
Methods
getEUID
Description
This method retrieves the EUID of a search result record.
Syntax
String getEUID() |
Parameters
None.
Returns
A string containing an EUID.
Throws
None.
getComparisonScore
Description
This method retrieves the weight that indicates how closely a search result record matched the search criteria.
Syntax
Float getComparisonScore() |
Parameters
None.
Returns
A comparison weight.
Throws
None.
getObjectName
Description
This method retrieves an object bean for a search result record.
Syntax
ObjectNameBean getObjectName() |
where ObjectName is the name of the parent object.
Parameters
None.
Returns
An object bean.
Throws
None.
SourceEO Master Index Class (Repository)
This class represents an enterprise object involved in a merge. This is the enterprise object whose EUID was not kept in the final merge result record. A SourceEO object is used when unmerging two enterprise objects.
Definition
class SourceEO |
Methods
getEnterpriseObjectName
Description
This method retrieves the non-surviving enterprise object from a merge transaction in order to allow the records to be unmerged.
Syntax
EnterpriseObjectName getEnterpriseObjectName() |
where ObjectName is the name of the parent object.
Parameters
None.
Returns
The non-surviving enterprise object from a merge transaction.
Throws
None.
SystemObjectNamePK Master Index Class (Repository)
This class represents the primary keys in a system object, which include the processing code for the originating system and the local ID of the object in that system. The class is named for the primary object. For example, if the primary object is named “Person”, this class is named SystemPersonPK. If the primary object is named “Company”, this class is named SystemCompanyPK. The methods in these classes provide the ability to create an instance of the class and to retrieve the system processing code and the local ID.
Definition
class SystemObjectNamePK |
where ObjectName is the name of the parent object.
Methods
SystemObjectNamePK
Description
This method is the user-defined system primary key object. This object contains a system code and a local ID. Use this constructor method to create a new instance of a system primary key object.
Syntax
new SystemObjectNamePK() |
where ObjectName is the name of the parent object.
Parameters
None.
Returns
An instance of the system primary key object.
Throws
None.
getLocalId
Description
This method retrieves the local identifier from a system primary key object.
Syntax
String getLocalId() |
Parameters
None.
Returns
A string containing a local identifier.
Throws
None.
getSystemCode
Description
This method retrieves the system’s processing code from a system primary key object.
Syntax
String getSystemCode() |
Parameters
None.
Returns
A string containing the processing code for a system.
Throws
None.
- © 2010, Oracle Corporation and/or its affiliates