Siebel Object Interfaces Reference > Siebel Object Interfaces Reference >

Format of the Object Interface Method

This topic describes formats for object interface methods, arguments, and return values. A Siebel object interface method uses the following format:

ObjectType.MethodName(arg1[, arg2, ..., argn])

where:

• Italicized text indicates a variable.
• Square brackets [ ] indicate an optional argument. The description of the argument indicates the default value for each optional argument.
• ObjectType is the object type. For example, BusComp indicates the business component that Siebel CRM defines for the object interface method.
• MethodName is the name of the object interface method that you call. A method can be a subroutine that does not return a value, such as SetViewMode, or a method that returns a value, such as GetFieldValue.
• arg1, arg2, or argn is a string, constant, integer, or object. Use parenthesis in the following ways:
  • In Siebel VB, if an object interface method returns a value, then enclose these arguments in parentheses.
  • in Siebel VB, if an object interface method does not return a value, then do not enclose these arguments in parentheses.
  • In Siebel eScript, always enclose these arguments in parentheses.

    If you use parentheses ( ) when none are required, or if you fail to use them if they are required, then Siebel CRM creates a Type Mismatch error that includes error code 13. Siebel CRM also creates this error if you use an incorrect number of arguments.

    If you use the COM Data Server interface, then you must include the errCode argument as the last argument.

Note how this book uses the following terms:

• ObjectReference is an ObjectType variable name that identifies the object that calls the object interface method. If you call a method on an object in the event handler of that object, then you are not required to explicitly specify the ObjectReference.
• returnValue is the value that the object interface method returns. Some methods, such as GetBusComp, return a business component object. Some methods return a string or integer. Some methods do not return any value.

Formats for Siebel VB

If there is a return value, then use the following format:

returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn)

If there are no arguments, then use the following format:

returnValue = ObjectReference.MethodName

If there is no return value, then use the following format:

ObjectReference.MethodName arg1, arg2, ..., argn

The following examples use Siebel VB:

acctName = acctBC.GetFieldValue("Name")

acctBC.SetViewMode AllView

Formats for Siebel eScript

If there is a return value, then use the following format:

returnValue = ObjectReference.MethodName(arg1, arg2, ..., argn);

If there are no arguments, then use the following format:

returnValue = ObjectReference.MethodName();

If there is no return value, then use the following format:

ObjectReference.MethodName(arg1, arg2, ..., argn);

The following examples use Siebel eScript:

acctName = acctBC.GetFieldValue("Name");

acctBC.SetViewMode(AllView);

Formats for the Component Object Model

The format that Siebel CRM uses for the Component Object Model (COM) depends on the language you use to call the COM interface. For Microsoft Visual Basic and equivalent languages, the format is similar to the format you use for Siebel VB, except that if you use COM Data Control, then Siebel CRM passes an error code as the final argument.