| Skip Navigation Links | |
| Exit Print View | |
|
Understanding Oracle Java CAPS Master Index Processing (Repository) Java CAPS Documentation |
| Skip Navigation Links | |
| Exit Print View | |
|
|
Understanding Oracle Java CAPS Master Index Processing (Repository) Java CAPS Documentation |
Understanding Oracle Java CAPS Master Index Processing (Repository)
About Oracle Java CAPS Master Index (Repository)
Understanding Master Index Operational Processes (Repository)
Learning About Master Index Message Processing (Repository)
Master Index Inbound Message Processing (Repository)
Master Index Outbound Message Processing (Repository)
Outbound Message Trigger Events
Master Index Inbound Message Processing Logic (Repository)
Master Index Custom Decision Point Logic (Repository)
Master Index Primary Function Processing Logic (Repository)
The Master Index Database Structure (Repository)
About the Master Index Database (Repository)
Master Index Database Table Details (Repository)
Sample Master Index Database Model (Repository)
Working with the Master Index Java API (Repository)
Master Index Java Class Types (Repository)
Static Master Index Java Classes (Repository)
Dynamic Master Index Object Classes (Repository)
Dynamic Business Process Methods
Dynamic Master Index Object Classes (Repository)
Master Index Parent Object Classes (Repository)
Master Index Child Object Classes (Repository)
Dynamic Master Index OTD Methods (Repository)
Dynamic Master Index OTD Methods (Repository)
Dynamic Business Process Methods (Repository)
Master Index Helper Classes (Repository)
SystemObjectName Master Index Class (Repository)
Master Index Parent Beans (Repository)
Master Index Child Beans (Repository)
DestinationEO Master Index Class (Repository)
SearchObjectNameResult Master Index Class (Repository)
SourceEO Master Index Class (Repository)
Master Index Match Types and Field Names (Repository)
Master Index Match and Standardization Types (Repository)
Oracle Java CAPS 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:
Oracle Java CAPS Master Index provides a set of static API classes that can be used with any object structure and any Oracle Java CAPS master index application. Oracle Java CAPS 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 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 Oracle Java CAPS Master Index.
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.
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.
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.
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:
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.
class ObjectNameObject
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.
new ObjectNameObject()
None.
An instance of the parent object.
ObjectException
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.
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)
|
None.
ObjectException
This method associates a new child object with the parent object. The object node passed as the parameter defines the child object type.
void addSecondaryObject(ObjectNode obj)
|
None.
SystemObjectException
This method copies the structure and field values of the specified object node.
ObjectNode copy()
None.
A copy of the object node.
ObjectException
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.
void dropSecondaryObject(ObjectNode obj)
|
None.
SystemObjectException
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
String getObjectNameId()
None.
A string containing the unique ID of the parent object.
ObjectException
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.
Collection getChild()
None.
A collection of child objects of the type specified in the method name.
None.
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.
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
None.
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
ObjectException
This method retrieves a list of the names of all child object types defined for the object structure.
ArrayList getChildTags()
None.
An array of child object names.
None.
This method retrieves the metadata for the parent object.
AttributeMetaData getMetaData()
None.
An AttributeMetaData object containing the parent object’s metadata.
None.
This method retrieves all child objects that are associated with the parent object and are of the specified type.
Collection getSecondaryObject(String type)
|
A collection of child objects of the specified type.
SystemObjectException
This method retrieves the value of the “add flag” for the parent object. The add flag indicates whether the object will be added.
String isAdded()
None.
A Boolean value indicating whether the add flag is set to true or false.
ObjectException
This method retrieves the value of the “remove flag” for the parent object. The remove flag indicates whether the object will be removed.
String isRemoved()
None.
A Boolean value indicating whether the remove flag is set to true or false.
ObjectException
This method retrieves the value of the “update flag” for the parent object. The update flag indicates whether the object will be updated.
String isUpdated()
None.
A Boolean value indicating whether the update flag is set to true or false.
ObjectException
This method sets the value of the ObjectNameId field in the parent object.
void setObjectNameId(Object value)
|
None.
ObjectException
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.
void setField(Object value)
|
None.
ObjectException
This method sets the “add flag” of the parent object. The add flag indicates whether the object will be added.
void setAddFlag(boolean flag)
|
None.
None.
This method sets the “remove flag” of the parent object. The remove flag indicates whether the object will be removed.
void setRemoveFlag(boolean e)
|
None.
None.
This method sets the “update flag” of the parent object. The update flag indicates whether the object will be updated.
void setUpdateFlag(boolean flag)
|
None.
None.
This method copies the structure of the specified object node.
ObjectNode structCopy()
None.
A copy of the structure of the object node.
ObjectException
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.
class ChildObject
This method represents the child object class. This class can be instantiated to create a new instance of a child object class.
new ChildObject()
None.
An instance of the child object.
ObjectException
This method copies the structure and field values of the specified object node.
ObjectNode copy()
None.
A copy of the object node.
ObjectException
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
String getChildId()
None.
A string containing the unique ID of the child object.
ObjectException
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.
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
None.
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
ObjectException
This method retrieves the metadata for the child object.
AttributeMetaData getMetaData()
None.
An AttributeMetaData object containing the child object’s metadata.
None.
This method retrieves the name of the parent object of the child object.
String getParentTag()
None.
A string containing the name of the parent object.
None.
This method sets the value of the ChildId field in the child object.
void setChildId(Object value)
|
None.
ObjectException
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.
void setField(Object value)
|
None.
ObjectException
This method copies the structure of the specified object node.
ObjectNode structCopy()
None.
A copy of the structure of the object node.
ObjectException
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.
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)
|
None.
RemoteException
ProcessingException
UserException
This method changes the status of a deactivated system object back to active.
void activateSystemRecord(String systemCode, String localId)
|
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)
|
None.
RemoteException
ProcessingException
UserException
This method changes the status of an active enterprise object to inactive.
void deactivateEnterpriseRecord(String euid)
|
None.
RemoteException
ProcessingException
UserException
This method changes the status of an active system object to inactive.
void deactivateSystemRecord(String systemCode, String localId)
|
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.
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.
MatchColResult executeMatch(SystemObjectBean systemObject)
|
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)
|
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 Oracle Java CAPS 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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
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)
|
None.
RemoteException
ProcessingException
UserException
This method updates the existing system object in the database with the given system object.
void updateSystemRecord(SystemObjectName systemObject)
|
None.
RemoteException
ProcessingException
UserException
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).
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:
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.
class SystemObjectName
The following methods are inherited from java.lang.Object.
equals
hashcode
notify
notifyAll
toString
wait()
wait(long arg)
wait(long timeout, int nanos)
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.
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.
new SystemObjectName()
None.
An instance of the SystemObjectName class.
ObjectException
This method retrieves the value of the ClearFieldIndicator field.
Object getClearFieldIndicator()
None.
An object containing the value of the ClearFieldIndicator field.
None.
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.
String getField()
or
Date getField()
None.
The value of the specified field. The type of value returned depends on the field from which the value was retrieved.
ObjectException
This method retrieves the parent object Java Bean for the system record.
ObjectNameBean getObjectName()
None.
A Java Bean containing the parent object.
None.
This method sets the value of the clear field character (in the ClearFieldIndicator field). By default, this is set to double quotes (“”).
void setClearFieldIndicator(String value)
|
None.
None.
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.
void setField(value)
|
None.
ObjectException
This method sets the parent object Java Bean for the system record.
void setObjectName(ObjectNameBean object)
|
None.
ObjectException
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.
final class ObjectNameBean
The following methods are inherited from java.lang.Object.
equals
hashcode
notify
notifyAll
toString
wait()
wait(long arg)
wait(long timeout, int nanos)
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.
new ObjectNameBean()
None.
An instance of the parent object Bean.
ObjectException
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).
int countChild()
None.
An integer indicating the number of child objects in a collection.
None.
This method returns a count of the total number of child objects belonging to a system object.
int countChildren()
None.
An integer representing the total number of child objects.
None.
This method returns a count of the total number of child objects of a specific type that belong to a system object.
int countChildren(String type)
|
An integer representing the total number of child objects of the specified type.
None.
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.
void deleteChild(String ChildId)
|
None.
ObjectException
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.
ChildBean[] getChild()
None.
An array of Java Beans containing the type of child objects specified by the method name.
None.
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.
ChildBean getChild(int i)
|
A Java Bean containing the child object specified by the index value. The method name indicates the type of child object returned.
ObjectException
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.
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
None.
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
ObjectException
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
String getObjectNameId()
None.
A string containing the unique ID of the parent object.
ObjectException
This method adds a child object to the system object.
void setChild(int index, ChildBean child)
|
None.
None.
This method adds an array of child objects of one type to the system object.
void setChild(ChildBean[] children)
|
None.
None.
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.
void setField(value)
|
None.
ObjectException
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.
void setObjectNameId(String value)
|
None.
ObjectException
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.
final class ChildBean
The following methods are inherited from java.lang.Object.
equals
hashcode
notify
notifyAll
toString
wait()
wait(long arg)
wait(long timeout, int nanos)
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.
new ChildBean()
None.
An instance of the child object Bean.
ObjectException
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.
void delete()
None.
None.
ObjectException
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.
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
None.
The value of the specified field. The type of data returned depends on the data type defined in the object definition.
ObjectException
This method retrieves the unique identification code (primary key) of the object, as assigned by the master index application.
String getChildId()
None.
A string containing the unique ID of the child object.
ObjectException
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.
void setField(value)
|
None.
ObjectException
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.
void setChildId(String value)
|
None.
ObjectException
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.
class DestinationEO
This method retrieves the surviving enterprise object from a merge transaction in order to allow the records to be unmerged.
EnterpriseObjectName getEnterpriseObjectName()
where ObjectName is the name of the parent object.
None.
The surviving enterprise object from a merge transaction.
ObjectException
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
class SearchObjectNameResult
This method retrieves the EUID of a search result record.
String getEUID()
None.
A string containing an EUID.
None.
This method retrieves the weight that indicates how closely a search result record matched the search criteria.
Float getComparisonScore()
None.
A comparison weight.
None.
This method retrieves an object bean for a search result record.
ObjectNameBean getObjectName()
where ObjectName is the name of the parent object.
None.
An object bean.
None.
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.
class SourceEO
This method retrieves the non-surviving enterprise object from a merge transaction in order to allow the records to be unmerged.
EnterpriseObjectName getEnterpriseObjectName()
where ObjectName is the name of the parent object.
None.
The non-surviving enterprise object from a merge transaction.
None.
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.
class SystemObjectNamePK
where ObjectName is the name of the parent object.
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.
new SystemObjectNamePK()
where ObjectName is the name of the parent object.
None.
An instance of the system primary key object.
None.
This method retrieves the local identifier from a system primary key object.
String getLocalId()
None.
A string containing a local identifier.
None.
This method retrieves the system’s processing code from a system primary key object.
String getSystemCode()
None.
A string containing the processing code for a system.
None.
|