Bookshelf Home | Contents | Index | Search | PDF |
Business Processes and Rules: Siebel eBusiness Application Integration Volume IV > Data Mapping Using Scripts > Siebel Message Objects and Methods >
CSSEAIPrimaryIntCompIn
This object represents the input primary integration component, open for reading. Your data transformation maps can use this object's methods to traverse integration components. This object provides Exists, FirstRecord, GetFieldValue, GetIntComp, and NextRecord methods:
Exists() Method
This method checks to see if the primary integration component is actually present in the input data. It takes no parameters.
Syntax
Exists()
Returns
Boolean
Usage
Call Exists after retrieving the primary integration component with the CSSEAIIntObjIn.GetPrimaryIntComp method, and before invoking the primary integration component's other methods.
If the primary integration component was found and is open for reading, the Exists method returns true.
FirstRecord() Method
This method moves a pointer to the first component record in the primary integration component.
Syntax
FirstRecord()
Returns
Boolean
Usage
Moves to the first integration component record and sets it as the active record. This method returns true if the record exists, false if the integration component has no records.
GetFieldValue() Method
This method returns the value of the primary integration component field from the active record. Table 24 presents the parameters for this method.
Syntax
GetFieldValue(name [, defaultIfNull [, defaultIfEmpty]])
Returns
String or null
Usage
A null value is returned if the active record does not contain the field. Otherwise, a string containing the value in the field is returned. If there is no active record, this method raises an error.
If the named argument does not exist, null is returned. If the named argument exists but the value is the empty string, the empty string is returned. You can use the defaultIfNull and defaultIfEmpty optional arguments to change this behavior.
The arguments defaultIfNull and defaultIfEmpty are optional; however, if you specify defaultIfEmpty, you must also specify the defaultIfNull argument.
GetIntComp() Method
This method returns the named integration component from the active record and opens it for input. Table 25 presents the parameter for this method.
Syntax
GetIntComp(name)
Table 25. Parameter for GetIntComp() Method Parameter Description name The name of an integration component in the active record.Returns
CSSEAIIntCompIn Input Integration Component
Usage
This method always returns an input 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 record, a call to this method raises an error.
NextRecord() Method
This method moves a pointer to the next logical record in the active integration component.
Syntax
NextRecord()
Returns
Boolean
Usage
Moves to the next record and makes it the active record. Returns true if the record exists, or false if there are no more records. Moves to the first record if neither the NextRecord method nor the FirstRecord method has been called previously.
Bookshelf Home | Contents | Index | Search | PDF |
Business Processes and Rules: Siebel eBusiness Application Integration Volume IV Published: 18 April 2003 |