| Skip Navigation Links | |
| Exit Print View | |
|
Oracle Java CAPS Master Index Processing Reference Java CAPS Documentation |
| Skip Navigation Links | |
| Exit Print View | |
|
|
Oracle Java CAPS Master Index Processing Reference Java CAPS Documentation |
Oracle Java CAPS Master Index Processing Reference
Understanding Operational Processes
Dynamic API Method Descriptions
Helper classes include objects that can be passed as parameters to a primary web services method. They also include the methods that you can access through the systemObjectName variable in Java clients or Business Processes (where ObjectName is the name of a parent object. The helper classes include:
Helper classes are located in the Master Index EJB project in the com.sun.mdm.index.webservice package.
A Java class is created to represent the entire object, which includes the single best record (SBR) and any associated system objects. The methods in this class provide the ability to retrieve, set, and delete system objects, and to retrieve and set attributes of the enterprise object.
The name of the enterprise object class is the same as the name of the application, with the word “Enterprise” prepended. For example, if the application name is “Person”, the name of the enterprise object class is “EnterprisePerson”. The methods in this class include a constructor method for the enterprise object, get and set methods for object attributes, and get, set, and delete methods for the system objects. Many methods have dynamic names based on the name of the parent object. In the following methods described for the enterprise object, ObjectName indicates the name of the parent object.
class ObjectNameObject
This is the constructor method for the enterprise object class. You can instantiate this class to create a new instance of the enterprise object.
new EnterpriseObjectName()
None.
An instance of the enterprise object.
None.
This method counts the system objects (class SystemObjectName) in the enterprise object. Use this method to loop through the system objects.
int countSystemObjectName()
None.
An integer representing the number of system objects.
None.
This method marks a system object for deletion from an instance of EnterpriseObjectName. The system object is deleted when the enterprise object is updated.
void deleteSystemObject(String system, String lid)
|
None.
ObjectException
This method marks a system object for deletion from an instance of EnterpriseObjectName. The system object is deleted when the enterprise object is updated.
void deleteSystemObjectBean(String system, String lid)
|
None.
ObjectException
This method retrieves the EUID from an instance of EnterpriseObjectName.
String getEUID()
None.
A string containing the EUID of the enterprise object.
ObjectException
This method retrieves the SBR from an instance of EnterpriseObjectName.
SBRObjectName getSBRObjectName()
None.
The SBR object from the enterprise object.
None.
This method retrieves the status of the enterprise object.
String getStatus()
None.
The status of the enterprise object.
ObjectException
This method retrieves all of the system objects associated with the enterprise object.
SystemObjectName[] getSystemObjectName()
None.
A collection of system objects.
None.
This method retrieves a system object based on its index in a list of system objects.
SystemObjectName getSystemObjectName(int index)
|
The system object at the specified index.
None.
This method returns the number of system objects in a collection of system objects.
int getSystemObjectNameCount()
None.
An integer indicating the number of system objects in an enterprise object.
None.
This method removes a system object from an enterprise object. Use this to remove the system object from the in-memory instance of EnterpriseObjectName. This does NOT result in the deletion of the system object from the database (see deleteSystemObject).
void removeSystemObject(String system, String lid)
|
None.
ObjectException
This method removes a system object from an enterprise object. Use this to remove the system object from the in-memory instance of EnterpriseObjectName. This does NOT result in the deletion of the system object from the database (see deleteSystemObjectBean).
void removeSystemObjectBean(String system, String lid)
|
None.
ObjectException
This method sets the value of the EUID field in an enterprise object.
void setEUID(String euid)
|
None.
ObjectException
This method sets the status of the enterprise object.
void setStatus(String status)
|
None.
ObjectException.
This method sets a collection of system objects in an enterprise object.
void setSystemObjetName(SystemObjectName[] systemObjectName)
|
None.
ObjectException.
In order to run executeMatch or executeMatchUpdatefrom a client application, 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 Clear Field Indicator).
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 clear field indicator 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 clear field indicator. By default, the clear field indicator is set to double-quotes (“”), so if a field is set to double-quotes, that field will be blanked out in the master index if the incoming record has a field value of null and the record being updated has a field value other than null. 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 clear field indicator.
Object getClearFieldIndicator()
None.
The clear field indicator.
None.
This method retrieves the value of the specified system field. There are getter methods for the following fields: LocalId, SystemCode, Status, CreateDateTime, CreateFunction, CreateUser, and UpdateUser.
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 system record JavaBean.
ObjectNameBean getObjectName()
None.
A JavaBean containing the system record.
None.
This method sets the value of the clear field indicator. 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, CreateUser, and UpdateUser.
void setField(value)
|
None.
ObjectException
This method sets the system object JavaBean.
void setObjectName(ObjectNameBean aObjectName)
|
None.
ObjectException
A JavaBean is created to represent the parent object defined in the object structure of the master index application. The methods in this class are generated based on the object structure and provide the ability to create a parent object Bean and to set or retrieve the field values for that JavaBean.
The name of the parent JavaBean class is the same as the name of the parent object, with the word “Bean” appended. For example, if the 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, get and set methods for each field defined for the parent object, and methods to manipulate child objects. Most methods have dynamic names 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 countPhone or countAddress.
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 JavaBeans. 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 object is named getAddress. A getter method is created for each child object in the parent object.
ChildBean[] getChild()
None.
An array of JavaBeans containing the type of child object specified by the method name.
None.
This method retrieves a child object JavaBean 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 JavaBean 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 structure.
ObjectException
This method retrieves the unique identification code (primary key) of the parent 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. You should never set this field manually.
void setObjectNameId(String value)
|
None.
ObjectException
A JavaBean is created to represent each child object defined in the object structure 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 JavaBean 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 JavaBean, 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
Note - These JavaBeans also include two countChildren methods, which are not currently used.
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 constructor for the user-defined object JavaBean class. You can instantiate this class to create a new instance of the JavaBean.
new ChildBean()
None.
An instance of the child object Bean.
ObjectException
This method removes the child object from its corresponding parent object. 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 structure.
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. You should never 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 method sets the surviving enterprise object of a merge transaction.
void setEnterpriseObjectName(EnterpriseObjectName eo)
where ObjectName is the name of the parent object.
|
None.
ObjectException
This class represents the return values for a call to the merge-related functions of the ObjectNameEJB class, where ObjectName is the name of the parent object.
class MergeObjectNameResult
This is the constructor method for the MergeObjectNameResult class.
new MergeObjectnameResult()
where ObjectName is the name of the parent object.
None.
A new instance of MergeObjectNameResult.
None.
This method retrieves the surviving enterprise object from a merge result.
DestinationEO getDestinationEO()
None.
The surviving enterprise object from a merge result.
None.
This method retrieves the nonsurviving enterprise object from a merge result.
SourceEO getSourceEO()
None.
The nonsurviving enterprise object from a merge result.
None.
This method sets the surviving enterprise object in a merge result.
void setDestinationEO(DestinationEO eom)
|
None.
None.
This method sets the nonsurviving enterprise object in a merge result.
void setSourceEO(SourceEO eom)
|
None.
None.
This class represents an SBR object in an enterprise object. The SBR (single best record) represents the data about an entity that is considered to be the most accurate information from all external systems. Many of the methods in this class are named based on the name of the parent object, which is represented by ObjectName in the method descriptions below.
class SBRObjectName
This is a constructor method for an empty SBRObjectName class.
new SBRObjectName()
None.
A new instance of SBRObjectName.
None.
This is a constructor method for an SBRObjectName class. It takes an SBR object as its input.
new SBRObjectName(SBR sbr)
|
None.
ObjectException
This method retrieves the parent object in the SBR.
ObjectNameBean getObjectName()
None.
The ObjectNameBean object associated with the SBR.
ObjectException
This method retrieves the status of the SBR.
String getStatus()
None.
The status of the SBR.
ObjectException
This method sets the parent object in the SBR.
void setObjectName(ObjectNameBean aObjectName)
|
None.
ObjectException
This method sets the status of the SBR.
voide setStatus(String status)
|
None.
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 method sets the EUID of a search result record.
void setEUID(String euid)
|
None.
None.
This method sets the weight that indicates how closely a search result record matched the search criteria.
void setComparisonScore(float score)
|
None.
None.
This method sets an object bean as a search result record.
void setObjectName(ObjectNameBean bean)
where ObjectName is the name of the parent object.
|
None.
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 nonsurviving 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 nonsurviving enterprise object from a merge transaction.
None.
This method sets the nonsurviving enterprise object from a merge transaction in order to allow the records to be unmerged.
void setEnterpriseObjectName(EnterpriseObjectName eo)
where ObjectName is the name of the parent object.
|
None.
ObjectException.
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.
|