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

CSSEAIIntMsgIn

This object represents an integration message that is open for reading. The object provides GetArgument and GetIntObj methods.

GetArgument() Method

This method gets the value of a business service argument. For example, this could get the name of a map function in the business service. Table 14 presents the parameters for this method.

Syntax

GetArgument(name [, defaultIfNull [, defaultIfEmpty]])

Returns

String or null.

Usage

Use this method to get the value of an argument passed to the business service. For example, if the MapName argument passed to the business service is MapExtOrderToOrder, the call:

intMsgIn.GetArgument("MapName");

returns the name of the map, MapExtOrderToOrder, passed to the business service.

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.

GetIntObj() Method

This method returns an instance of the integration object and opens it for reading. Table 15 presents the parameter for this method.

Syntax

GetIntObj(name)

Returns

CSSEAIIntObjIn Integration Object

Usage

An integration object instance is always returned even if the integration object does not exist. Call the returned object's Exist method to test for this before calling other methods on the object. An error is raised if an integration object is present but the name is not correct.

NOTE:  Currently an integration message can contain only one integration object.

GetAttachmentCount() Method

This method returns the number of attachments in the input integration message.

Syntax

GetAttachmentcount()

Returns

The number of attachments in the input integration message.

GetAttachment() Method

This method returns the attachment specified by the index. Table 16 presents the parameter for this method.

Syntax

GetAttachment(index)

Returns

The attachment (a PropertySet) specified by the index. The index is zero based. Returns null if index is out of bounds.

GetAttachmentByCID() Method

This method retrieves an attachment based on the Content Identifier (CID). Table 17 presents the parameter for this method.

Syntax

GetAttachmentByCID(cid)

Returns

The attachment (a PropertySet) specified by the CID. Returns null if there is no attachment with the specified CID.