Siebel Object Interfaces Reference


Introduction to Object Interfaces

How This Guide Is Organized

Typographic Conventions

Revision History


Back to top


Siebel Programming Tools

Components of the Siebel Programming Environment

Supported Uses of Siebel Programming Languages

Business Rule Definition

Custom Behavior for User Interface Components

Choosing Your Scripting Language

Adding New Business Rules to a Business Component

The Siebel Script Editor

Using the Siebel Script Editor

Scripted Flag

Script Editing Preferences

The Siebel Debugger

Using the Siebel Debugger

Debugging and Run-Time Preferences

Checking Syntax

Breakpoints

Variable Window

Siebel Calls Window

Script Tracing

Siebel Compiler and Run-Time Engine

Getting Started with Siebel VB

A Few Notes About Siebel eScript


Back to top


Programming

Installing Siebel Object Interfaces

Siebel Object Interfaces

Siebel COM Interfaces

Siebel Java Interfaces

Siebel CORBA Interfaces

Built-in Scripting

Usage Evaluation Matrix

Exposed Object Types

Application Object Type

Business Object Object Type

Business Component Object Type

Business Service Object Type

Applet Object Type

Property Set Object Type

User Interface Control Object Type

Application Factory Object Type

Summary of Exposed Object Types

Siebel Object Interface Method Syntax

Getting Started with the Siebel Object Interfaces

Accessing Siebel COM Interfaces

Accessing the Siebel Web Client Automation Server

Accessing the Siebel Mobile/Dedicated Web Client Automation Server

Instantiating the Siebel COM Data Server

Instantiating the Siebel COM Data Control

Java Data Bean

Accessing Siebel CORBA Interfaces

Initializing ORB and Binding Siebel App Factory (Orbix)

Initializing ORB and Binding Siebel App Factory (Visibroker)

Siebel Object Interface Methods

Locating Objects

Accessing Business Components

Navigation

User Interaction

Global State Properties and Functions

Creating a Siebel Application Object in CORBA

Variable Scoping for Siebel Script Variables

Local Variables

Module Variables

Global Variables

Inter-Application Variable Methods

Tracing

Siebel Object Interface Events and Siebel Extension Events

Event Method Syntax

How Your Script Affects Program Flow

When Events Occur

Siebel Business Component Events

Applet Events

Application Events

Connect String

Error Handling


Back to top


Interfaces Reference

Object Interface Methods Tables

Applet

Application

Business Component

Business Object

Business Service

Control

Property Set

SiebelApp Factory

Siebel Exceptions

Miscellaneous Methods and Events

Object Interface Events

Applet

Application

Business Component Events

Business Service Events

Siebel Constants

Applet Methods

ActiveMode

BusComp

BusObject

FindActiveXControl

FindControl

InvokeMethod

Name

Applet Events

Applet_ChangeFieldValue

Applet_ChangeRecord

Applet_InvokeMethod

Applet_Load

Applet_PreInvokeMethod

WebApplet_InvokeMethod

WebApplet_Load

WebApplet_PreCanInvokeMethod

WebApplet_PreInvokeMethod

WebApplet_ShowControl

WebApplet_ShowListColumn

Application Methods

ActiveApplet

ActiveBusComp

ActiveBusObject

ActiveViewName

Attach

CurrencyCode

Detach

EnableExceptions

FindApplet

GetBusObject

GetDataSource

GetLastErrCode

GetLastErrText

GetProfileAttr

GetService

GetSharedGlobal

GotoView

InvokeMethod

LoadObjects

LoadUserAttributes

Login

LoginId

LoginName

Logoff

LookupMessage

LookupValue

Name

NewPropertySet

PositionId

PositionName

RaiseError

RaiseErrorText

Release

SetPositionId

SetPositionName

SetProfileAttr

SetSharedGlobal

SWEAlert

Trace

TraceOff

TraceOn

Application Events

Application_Close

Application_InvokeMethod

Application_Navigate

Application_PreInvokeMethod

Application_PreNavigate

Application_Start

Business Component Methods

ActivateField

ActivateMultipleFields

Associate

BusObject

ClearToQuery

DeactivateFields

DeleteRecord

ExecuteQuery

ExecuteQuery2

FirstRecord

FirstSelected

GetAssocBusComp

GetFieldValue

GetFormattedFieldValue

GetLastErrCode

GetLastErrText

GetMultipleFieldValues

GetMVGBusComp

GetNamedSearch

GetPicklistBusComp

GetSearchExpr

GetSearchSpec

GetUserProperty

GetViewMode

InvokeMethod

InvokeMethod Methods

LastRecord

Name

NewRecord

NextRecord

NextSelected

ParentBusComp

Pick

PreviousRecord

RefineQuery

Release

SearchExpr

SetFieldValue

SetFormattedFieldValue

SetMultipleFieldValues

SetNamedSearch

SetSearchExpr

SetSearchSpec

SetSortSpec

SetUserProperty

SetViewMode

UndoRecord

ViewMode

WriteRecord

Business Component Events

BusComp_Associate

BusComp_ChangeRecord

BusComp_CopyRecord

BusComp_DeleteRecord

BusComp_InvokeMethod

BusComp_NewRecord

BusComp_PreAssociate

BusComp_PreCopyRecord

BusComp_PreDeleteRecord

BusComp_PreGetFieldValue

BusComp_PreInvokeMethod

BusComp_PreNewRecord

BusComp_PreQuery

BusComp_PreSetFieldValue

BusComp_PreWriteRecord

BusComp_Query

BusComp_SetFieldValue

BusComp_WriteRecord

Business Object Methods

GetBusComp

GetLastErrCode

GetLastErrText

Name

Release

Business Service Methods

GetFirstProperty

GetLastErrCode

GetLastErrText

GetNextProperty

GetProperty

InvokeMethod

Name

PropertyExists

Release

RemoveProperty

SetProperty

Business Service Events

Service_InvokeMethod

Service_PreCanInvokeMethod

Service_PreInvokeMethod

Control Methods

Applet

BusComp

GetProperty

GetValue

Name

SetLabelProperty

SetProperty

SetValue

Property Set Methods

AddChild

Copy

GetChild

GetChildCount

GetFirstProperty

GetNextProperty

GetProperty

GetPropertyCount

GetType

GetValue

InsertChildAt

PropertyExists

RemoveChild

RemoveProperty

Reset

SetProperty

SetType

SetValue

SiebelAppFactory Methods

CreateSiebelAppObject

Release

Miscellaneous Methods

GetErrorCode

GetErrorMessage();

TheApplication


Back to top


Accessing Siebel COM Data Server with C++

Building the Siebel COM Client in C++

Testing Your Program


Back to top


COM Data Control Quick Reference

Application

Business Component

Business Object

Business Service

Property Set


Back to top


COM Data Server Quick Reference

Application

Business Component

Business Object

Business Service

Property Set


Back to top


Mobile/Dedicated Web Client Automation Server Quick Reference

Application

Business Component

Business Object

Business Service

Property Set


Back to top


Siebel Web Client Automation Server Quick Reference

SiebelHTMLApplication

SiebelService

PropertySet


Back to top


Java Data Bean Quick Reference

Data Bean

Business Component

Business Object

Business Service

Property Set

SiebelException


Back to top


CORBA Quick Reference

CORBA Interfaces and Unicode

Application

Business Component

Business Object

Business Service

Property Set

SiebelAppFactory

SiebelException

desc

id


Back to top


Siebel VB Quick Reference

Applet

Application

Business Component

Business Object

Business Service

Property Set

Miscellaneous Interfaces and Events


Back to top


Browser Scripting

Browser Script Events and Methods

Applet

Application

Business Component

Business Object

Business Service

PropertySet

Control

Supported DOM Events for High Interactivity Mode

Supported DOM Events for Standard Interactivity Mode


Back to top


Siebel eScript Quick Reference

Applet

Application

Business Component

Business Object

Business Service

PropertySet

Miscellaneous Interfaces and Events


Back to top


Invoking Custom Methods with MiniButtons

Invoking Custom Methods

Back to top


 Siebel Object Interfaces Reference 
 Published: 18 June 2003