Bookshelf Home | Contents | Index | Search | PDF

Siebel Object Interfaces Reference > Programming >

Siebel Object Interface Method Syntax

---

The following conventions are used in this guide to describe methods, arguments, and return values:

Syntax

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

Argument	Description
arg1	Description of arg1
arg2	Description of arg2
.	.
.	.
argn	Description of argn

Returns

Description of the value returned by the method, if any.

The following conventions are used in the syntax diagram:

ObjectType is the object type, for example BusComp (business component), for which the method is defined.
MethodName is the name of the method that is being invoked. A method can be a subroutine that does not return a value, such as SetViewMode, or a function that returns a value, such as GetFieldValue.
arg1, arg2 can be a string, constant, integer, or object. If a method returns a value, the arguments must be enclosed in parentheses in Siebel VB. In Siebel eScript, enclose arguments in parentheses, even if they do not return a value.
Brackets [ ] indicate an optional parameter. In the description of the argument, the default value for the optional parameter is indicated.

If a method does not return a value or if you are using it in a manner that does not return a value, then the arguments should not be enclosed in parentheses in Siebel VB.

When the using the COM Data Server, an additional argument, errCode, is always required as the last argument.

Usage Syntax

The usage syntax for a method may differ between Server Script and COM, as described in the text that follows. The description uses the following terms in addition to the ones defined previously:

ObjectReference is a variable name of type ObjectType that points to the object on which the method is invoked.

NOTE:  You do not need to explicitly specify an ObjectReference when you invoke a method on an object inside its event handler.

returnValue is the value, if any, that is returned by the method. Some methods, such as GetBusComp, return an object of the type business component. Other methods return strings or integers.

Siebel VB

If there is a return value,

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

If there are no arguments,

returnValue = ObjectReference.MethodName

If there is no return value,

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

Examples

acctName = acctBC.GetFieldValue("Name")

acctBC.SetViewMode AllView

Siebel eScript

If there is a return value,

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

If there are no arguments,

returnValue = ObjectReference.MethodName();

If there is no return value,

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

Examples

acctName = acctBC.GetFieldValue("Name");

acctBC.SetViewMode(AllView);

Using parenthesis ( ) when none are required, or failing to use them when they are required, generates a Type Mismatch (error code 13) message. Another cause of this error code is using an incorrect quantity of arguments.

COM

The usage depends on the language being used to call the COM Interfaces. For Microsoft Visual Basic and equivalent languages, the usage is similar to that of Siebel VB, except that an error code is passed as the final argument in the case of the COM Data Control.

Bookshelf Home | Contents | Index | Search | PDF