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() |
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) |
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. |
None.
ObjectException
This method sets the value of the ChildId field in the child object.
This ID is set internally by the master index application. Do not set this field manually.
void setChildId(String value) |
Name |
Type |
Description |
---|---|---|
value |
String |
The value of the ChildId field. |
None.
ObjectException