Understanding Sun Master Index Processing (Repository)

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.

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