Siebel Object Interfaces Reference > Siebel eScript Quick Reference >

Business Component Methods for eScript


Table 88 lists a summary of the business component methods' syntax.

Table 88 does not include methods that are not invoked directly from a Business Component object instance. For information on methods that are called with InvokeMethod on the Business Component object, see InvokeMethod Methods for the Business Component Object.

Table 88. Business Component Methods Syntax Summary
Method
Description
Syntax

ActivateField Method

Allows queries to retrieve data for the specified field.

var myBusComp;
myBusComp.ActivateField(fieldName);

ActivateMultipleFields Method

Allows queries to retrieve data for the fields specified in the property set.

var myBusComp;
myBusComp.ActivateMultipleFields(oPropSet);

Associate Method

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

var myBusComp;
myBusComp.Associate(whereIndicator);

BusObject Method

Returns the business object that contains the business component.

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

ClearToQuery Method

Clears the current query and sort specifications on the business component.

var myBusComp;
myBusComp.ClearToQuery();

DeactivateFields Method

Deactivates every currently activated field.

var myBusComp;
myBusComp.DeactivateFields();

DeleteRecord Method

Removes the current record from the business component.

var myBusComp;
myBusComp.DeleteRecord();

ExecuteQuery Method

Retrieves a set of BusComp records.

var myBusComp;
myBusComp.ExecuteQuery(cursorMode);

ExecuteQuery2 Method

Retrieves a set of BusComp records.

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

FirstRecord Method

Moves to the first record in the business component.

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

FirstSelected Method

Moves to the first record of the multiple selection in the business component.

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

GetAssocBusComp Method

Returns the association business component.

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

GetFieldValue Method

Returns a value for the field specified in the argument.

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

GetFormattedFieldValue Method

Returns a formatted value for the field specified in the argument.

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

GetMultipleFieldValues Method

Returns a value for the fields specified in the property set.

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

GetMVGBusComp Method

Returns the MVG business component associated with the field specified in the argument.

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

GetNamedSearch Method

Returns the named search specification specified in the argument.

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

GetPicklistBusComp Method

Returns the pick business component associated with the field specified in the argument.

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

GetSearchExpr Method

Returns the current search expression.

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

GetSearchSpec Method

Returns the current search specification for the field specified in the argument.

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

GetSortSpec Method

Returns the active sort specification of the object that has context.

var sSortSpec = this.GetSortSpec();

GetUserProperty Method

Returns the value for a property name specified in the argument.

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

GetViewMode Method

Returns the visibility mode for the business component.

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

InvokeMethod Method

Calls the specialized method named in the argument.

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

LastRecord Method

Moves to the last record in the business component.

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

Name Method

Returns the name of the business component.

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

NewRecord Method

Adds a new record to the business component.

var myBusComp;
myBusComp.NewRecord(whereIndicator);

NextRecord Method

Moves to the next record in the business component.

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

NextSelected Method

Moves to the next record of the current multiple selection.

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

ParentBusComp Method

Returns the parent business component.

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

Pick Method

Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.

var myBusComp;
myBusComp.Pick();

PreviousRecord Method

Moves to the previous record in the business component.

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

RefineQuery Method

Refines a query after a query has been executed.

var myBusComp;
myBusComp.RefineQuery();

SetFieldValue Method

Assigns a new value to the named field for the current row of the business component.

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

SetFormattedFieldValue Method

Accepts the field value in the current local format and assigns the new value to the named field for the current row of the business component.

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

SetMultipleFieldValues Method

Assigns a new value to the fields specified in the property set for the current row of the business component.

var myBusComp;
myBusComp.SetMultipleFieldValues
(oPropSet);

SetNamedSearch Method

Sets a named search specification on the business component.

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

SetSearchExpr Method

Sets the search specification for the business component.

var myBusComp;
myBusComp.SetSearchExpr(searchSpec);

SetSearchSpec Method

Sets the search specification for the specified field.

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

SetSortSpec Method

Sets the sort specification for a query.

var myBusComp;
myBusComp.SetSortSpec(sortSpec);

SetUserProperty Method

Sets the value of the specified User Property.

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

SetViewMode Method

Sets the visibility type for the business component.

var myBusComp;
myBusComp.SetViewMode(viewMode);

UndoRecord Method

Reverses any uncommitted changes made to the record.

var myBusComp;
myBusComp.UndoRecord();

WriteRecord Method

Commits to the database any changes made to the current record.

var myBusComp;
myBusComp.WriteRecord();

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