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() |
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) |
Name |
Type |
Description |
---|---|---|
value |
Object |
An object containing the value of the ChildId field. |
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) |
Name |
Type |
Description |
---|---|---|
value |
Object |
An object containing the value of the field specified by the method name. |
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