Siebel Object Interfaces Reference > Siebel eScript Quick Reference > Object Interfaces Reference >

Business Component Methods for Siebel eScript


Table 130 describes a summary of business component methods you can use with Siebel eScript. It does not include object interface methods that Siebel CRM does not call directly from a business component. For information about methods that Siebel CRM calls with the InvokeMethod method on a business component, see Business Component Invoke Methods.

Table 130. Summary of Business Component Methods for Siebel eScript
Method
Description
Format

ActivateField Method for a Business Component

Activates a field.

var myBusComp;
myBusComp.ActivateField(fieldName);

ActivateMultipleFields Method for a Business Component

Activates multiple fields.

var myBusComp;
myBusComp.ActivateMultipleFields(oPropSet);

Associate Method for a Business Component

Creates a new many-to-many relationship for the parent object through an association business component.

var myBusComp;
myBusComp.Associate(whereIndicator);

BusObject Method for a Business Component

Returns the name of the business object that the business component references.

var myBusComp;
var busObject;
busObject = myBusComp.BusObject();

ClearToQuery Method for a Business Component

Clears the current query but does not clear sort specifications on a business component.

var myBusComp;
myBusComp.ClearToQuery();

DeactivateFields Method for a Business Component

Deactivates the fields that are currently active from the SQL query statement of a business component.

var myBusComp;
myBusComp.DeactivateFields();

DeleteRecord Method for a Business Component

Removes the current record from a business component.

var myBusComp;
myBusComp.DeleteRecord();

ExecuteQuery Method for a Business Component

Returns a set of business component records.

var myBusComp;
myBusComp.ExecuteQuery(cursorMode);

ExecuteQuery2 Method for a Business Component

Returns a set of business component records. Allows you to control the number of records Siebel CRM returns.

var myBusComp;
myBusComp.ExecuteQuery2(cursorMode, ignoreMaxCursorSize);

FirstRecord Method for a Business Component

Moves the record pointer to the first record in a business component, making that record the current record.

var myBusComp;
var bIsRecord;
bIsRecord = myBusComp.FirstRecord();

FirstSelected Method for a Business Component

Makes the first record of the multiple selection in a business component active.

var myBusComp;
var bIsMultipleSelection;
bIsMultipleSelection =
myBusComp.FirstSelected();

GetAssocBusComp Method for a Business Component

Returns the name of the association business component.

var myBusComp;
var AssocBusComp;
AssocBusComp = myBusComp.GetAssocBusComp();

GetFieldValue Method for a Business Component

Returns the value of a field from the current record of a business component.

var myBusComp;
var sValue;
sValue = myBusComp.GetFieldValue(FieldName);

GetFormattedFieldValue Method for a Business Component

Returns a field value that is in the same format that the Siebel client uses.

var myBusComp;
var sValue;
sValue = myBusComp.GetFormattedFieldValue(FieldName);

GetMultipleFieldValues Method for a Business Component

Returns a value for each field specified in a property set.

var myBusComp;
myBusComp.GetMultipleFieldValues
(oFields, oValues );

GetMVGBusComp Method for a Business Component

Returns the multivalue group business component that is associated a business component field.

var myBusComp;
var MvgBusComp;
MvgBusComp= myBusComp.GetMVGBusComp(FieldName);

GetNamedSearch Method for a Business Component

Returns the name of a search specification.

var myBusComp;
var sValue;
sValue = myBusComp.GetNamedSearch(SearchName);

GetPicklistBusComp Method for a Business Component

Returns the name of the pick business component that is associated with a field in the current business component.

var myBusComp;
var pickBusComp;
pickBusComp = myBusComp.GetPicklistBusComp
(FieldName);

GetSearchExpr Method for a Business Component

Returns the current search expression that is defined for a business component.

var myBusComp;
var sExpr;
sExpr = myBusComp.GetSearchExpr();

GetSearchSpec Method for a Business Component

Returns the search specification that is defined for a business component.

var myBusComp;
var sSpec;
sSpec = myBusComp.GetSearchSpec(FieldName);

GetSortSpec Method for a Business Component

Returns the sort specification for a business component.

var sSortSpec = this.GetSortSpec();

GetUserProperty Method for a Business Component

Returns the value of a user property.

var myBusComp;
var sValue;
sValue = myBusComp.GetUserProperty
(propertyName);

GetViewMode Method for a Business Component

Returns the visibility mode for a business component.

var myBusComp;
var iMode;
iMode = myBusComp.GetViewMode();

InvokeMethod Method for a Business Component

Calls a method.

var myBusComp;
var sReturn;
sReturn = myBusComp.InvokeMethod(methodName, methodArg1, methodArg2,..., methodArgn);

LastRecord Method for a Business Component

Moves the record pointer to the last record in a business component.

var myBusComp;
var iReturn;
iReturn = myBusComp.LastRecord();

Name Method for a Business Component

Returns the name of a business component.

var myBusComp;
var sName;
sName = myBusComp.Name();

NewRecord Method for a Business Component

Adds a new record to a business component.

var myBusComp;
myBusComp.NewRecord(whereIndicator);

NextRecord Method for a Business Component

Moves the record pointer to the next record in a business component, making that record the current record.

var myBusComp;
var bFound;
bFound = myBusComp.NextRecord();

NextSelected Method for a Business Component

Makes the next record of the current multiple selection the active record.

var myBusComp;
var iReturn;
iReturn = myBusComp.NextSelected();

ParentBusComp Method for a Business Component

Returns the name of a parent business component.

var myBusComp;
var parentBusComp;
parentBusComp = myBusComp.ParentBusComp();

Pick Method for a Business Component

Places the currently chosen record in a pick business component into the appropriate fields of the parent business component.

var myBusComp;
myBusComp.Pick();

PreviousRecord Method for a Business Component

Moves the record pointer to the previous record in a business component, making that record the current record.

var myBusComp;
var iReturn;
iReturn = myBusComp.PreviousRecord();

RefineQuery Method for a Business Component

Refines a query.

var myBusComp;
myBusComp.RefineQuery();

SetFieldValue Method for a Business Component

Sets a new value in a field for the current record of a business component.

var myBusComp;
myBusComp.SetFieldValue(FieldName, FieldValue);

SetFormattedFieldValue Method for a Business Component

Sets a new value in a field in the current record of a business component. It accepts the field value in the current local format.

var myBusComp;
myBusComp.SetFormattedFieldValue
(FieldName, FieldValue);

SetMultipleFieldValues Method for a Business Component

Sets new values in the fields of the current record of a business component.

var myBusComp;
myBusComp.SetMultipleFieldValues
(oPropSet);

SetNamedSearch Method for a Business Component

Sets a named search specification on a business component.

var myBusComp;
myBusComp.SetNamedSearch(searchName, searchSpec);

SetSearchExpr Method for a Business Component

Sets a search expression for a business component.

var myBusComp;
myBusComp.SetSearchExpr(searchSpec);

SetSearchSpec Method for a Business Component

Sets the search specification for a business component.

var myBusComp;
myBusComp.SetSearchSpec(FieldName, searchSpec);

SetSortSpec Method for a Business Component

Sets the sort specification for a business component.

var myBusComp;
myBusComp.SetSortSpec(sortSpec);

SetUserProperty Method for a Business Component

Sets the value of a user property in a business component.

var myBusComp;
myBusComp.SetUserProperty
(propertyName, newValue);

SetViewMode Method for a Business Component

Sets the visibility type for a business component.

var myBusComp;
myBusComp.SetViewMode(viewMode);

UndoRecord Method for a Business Component

Reverses any unsaved modifications made to the record.

var myBusComp;
myBusComp.UndoRecord();

WriteRecord Method for a Business Component

Saves to the Siebel database any modifications made to the current record.

var myBusComp;
myBusComp.WriteRecord();

Siebel Object Interfaces Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.