Business Processes and Rules: Siebel eBusiness Application Integration Volume IV > Data Mapping Using Scripts > Siebel Message Objects and Methods >

CSSEAIIntObjIn

This object represents an input integration object, open for reading, that is contained in the integration message. The integration object has a name and contains zero or more instances of actual integration objects. Integration object instances are accessed one at a time, similar to accessing database records. Each instance has a primary integration component that contains data and every subordinate integration components. This object provides the Exists, FirstInstance, GetPrimaryIntComp, and NextInstance methods.

Exists() Method

This method checks to see if the integration object is actually present in the input data. It takes no parameters.

Syntax

Exists()

Returns

Boolean

Usage

Call Exists after retrieving the integration object from the integration message. If the integration object was found and is open for reading, the Exists method returns true.

FirstInstance() Method

This method moves to the first integration object instance and sets it as the active instance.

Syntax

FirstInstance()

Returns

Boolean

Usage

The FirstInstance method returns true if the instance exists, false otherwise.

GetPrimaryIntComp() Method

This method returns the primary integration component of the active instance of the integration object. Table 22 presents the parameter for this method.

Syntax

GetPrimaryIntComp(name)

Returns

CSSEAIPrimaryIntCompIn Input Primary Integration Component

Usage

Gets the primary integration component of the active instance of the integration object and opens it for input.

This method always returns an input primary integration component object, even if the component does not exist. Call the Exists method on the returned object to test for this condition. If there is no active instance, a call to this method raises an error.

NextInstance() Method

This method moves a pointer to the next logical integration object instance in the active integration message.

Syntax

NextInstance()

Returns

Boolean

Usage

Moves to the next integration object instance and makes it the active instance. This method returns true if the instance exists, or false if there are no more instances. If neither the NextInstance or the FirstInstance method has been called previously, the NextInstance method moves to the first instance in the message.