Siebel Object Interfaces Reference > COM Data Server Quick Reference >

Application Methods for COM Data Server


Table 41 lists a summary of the application methods' syntax.

Table 41 does not include methods that are not invoked directly from an Application object instance. For information on methods that are called with InvokeMethod on the Application object, see InvokeMethod Methods for the Application Object.

Table 41. Application Methods Syntax Summary
Method
Description
Syntax

CurrencyCode Method

Returns the three-letter operating currency code.

Dim application as SiebelApplication
Dim sCur as String
sCur = Application.CurrencyCode(ErrCode as Integer)

GetBusObject Method

Instantiates and returns a new instance of the business object specified in the argument.

Dim application as SiebelApplication
Dim busObject as SiebelBusObject
set busObject = application.GetBusObject(busobjName as String, ErrCode as Integer)

GetLastErrText Method

Returns the last error text message.

Dim application as SiebelApplication
Dim sText as String
sText = application.GetLastErrText(ErrCode as Integer)

GetProfileAttr Method

Returns the value of an attribute in a user profile.

Dim application as SiebelApplication
Dim sText as String
sText = application.GetProfileAttr(Name as String)

GetService Method

Instantiates and returns a new instance of the argument-specified service.

Dim Application as SiebelApplication
Dim Service as SiebelService
set Service = Application.GetService(serviceName as String, ErrCode as Integer)

GetSharedGlobal Method

Gets the shared user-defined global variables.

Dim application as SiebelApplication
Dim sName as String
sName = application.GetSharedGlobal(varName as String, ErrCode as Integer)

InvokeMethod Method

Calls the named specialized method.

Dim application as SiebelApplication
application.InvokeMethod(methodName as String, methodArgs as String or StringArray)

LoadObjects Method

Starts the COM Data Server object and returns a reference to the Application object.

Dim application as SiebelApplication
application.LoadObjects(pathName\cfgFileName as String, ErrCode as Integer)

Login Method

Allows external applications to log in to the COM Data Server.

Dim application as SiebelApplication
application.Login(userName as String, password as String, ErrCode as Integer)

LoginId Method

Returns the login ID of the user who started the Siebel application.

Dim application as SiebelApplication
Dim sID as String
sID = application.LoginId(ErrCode as Integer)

LoginName Method

Returns the login name of the user who started the Siebel application.

Dim application as SiebelApplication
Dim sUser as String
sUser = application.LoginName(ErrCode as Integer)

NewPropertySet Method

Constructs and returns a new property set object.

Dim oApplication as SiebelApplication
Dim oPropSet as SiebelPropertySet
oPropSet = oApplication.NewPropertySet()

PositionId Method

Returns the position ID that describes the user's current position.

Dim application as SiebelApplication
Dim sRow as String
sRow = application.PositionId(ErrCode as Integer)

PositionName Method

Returns the position name of the user's current position.

Dim application as SiebelApplication
Dim sPosition as String
sPosition = application.PositionName(ErrCode as Integer)

SetPositionId Method

Sets the active position to the position ID specified in the argument. Returns a Boolean value indicating if the method succeeded.

Dim application as SiebelApplication
Dim posId as String
Dim status as Boolean
status = application.SetPositionId(posId as String, ErrCode as Integer)

SetPositionName Method

Sets the active position to the position name specified in the argument. Returns a Boolean value indicating if the method succeeded.

Dim application as SiebelApplication
Dim posName as String
Dim status as Boolean
status = application.SetPositionName(posName as String, ErrCode as Integer)

SetProfileAttr Method

Used in personalization to assign values to attributes in a user profile.

Dim application as SiebelApplication
application.SetProfileAttr(name as String, value as String, ErrCode as Integer)

SetSharedGlobal Method

Sets a shared user-defined global variable.

Dim application as SiebelApplication
application.SetSharedGlobal(varName as String, value as String, ErrCode as Integer)

Trace Method

Appends a message to the trace file.

Dim application as SiebelApplication
application.Trace(message as String, ErrCode as Integer)

TraceOff Method

Turns off the tracing started by TraceOn.

Dim application as SiebelApplication
application.TraceOff(ErrCode as Integer)

TraceOn Method

Turns tracing on

Dim application as SiebelApplication
application.TraceOn(filename as String, type as Integer, Selection as String, ErrCode as Integer)

Siebel Object Interfaces Reference Copyright © 2008, Oracle. All rights reserved.