Business Processes and Rules: Siebel Enterprise Application Integration > Data Mapping Using Scripts > Siebel Message Objects and Methods >
CSSEAIIntCompIn
This object represents the input integration component, open for reading. You can use the object's methods to traverse actual integration components and to retrieve data from those integration components. This object provides Exists, FirstRecord, GetFieldValue, GetIntComp, and NextRecord methods. Exists() Method
This method checks to see if the integration component is actually present in the input data. It takes no parameters. Syntax
Exists() Returns
Boolean Usage
Call Exists after retrieving the integration component from its parent object using the GetIntComp method, and before invoking the integration component's other methods. If the integration component is 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 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 integration component field from the active record. Table 29 presents the parameters for this method. Syntax
GetFieldValue(name [, defaultIfNull [, defaultIfEmpty]])
Table 29. Parameters for GetFieldValue() Method
|
|
name |
The name of an integration component field. |
defaultIfNull |
Optional. Value to return if the field does not exist. |
defaultIfEmpty |
Optional. Value to return if the field is set to an empty string. |
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 arguments to change this behavior. NOTE: 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 integration component from the active record and opens it for input. Table 30 presents the parameter for this method. Syntax
GetIntComp(name)
Table 30. Parameter for GetIntComp() Method
|
|
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. NOTE: 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.
|