Siebel Object Interfaces Reference > Siebel eScript Quick Reference >

Business Component

Table 82 lists a summary of the Business Component Methods syntax.

Table 82.  Business Component Methods Syntax Summary
Method
Description
Syntax
ActivateField
Allows queries to retrieve data for the specified field.

var myBusComp;
myBusComp.ActivateField(fieldName);
ActivateMultipleFields
Allows queries to retrieve data for the fields specified in the property set.

var myBusComp;
myBusComp.ActivateMultipleFields(oPropSet);
Associate
Creates a new many-to-many relationship for the parent object through an association business component.

var myBusComp;
myBusComp.Associate(whereIndicator);
BusObject
Returns the business object that contains the business component.

var myBusComp;
var busObject;
busObject = myBusComp.BusObject();
ClearToQuery
Clears the current query and sort specifications on the business component.

var myBusComp;
myBusComp.ClearToQuery();
DeactivateFields
Deactivates every currently activated field.

var myBusComp;
myBusComp.DeactivateFields();
DeleteRecord
Removes the current record from the business component.

var myBusComp;
myBusComp.DeleteRecord()
ExecuteQuery
Retrieves a set of BusComp records.

var myBusComp;
myBusComp.ExecuteQuery(cursorMode);
ExecuteQuery2
Retrieves a set of BusComp records.

var myBusComp;
myBusComp.ExecuteQuery2(cursorMode, ignoreMaxCursorSize);
FirstRecord
Moves to the first record in the business component.

var myBusComp;
var bIsRecord;
bIsRecord = myBusComp.FirstRecord();
FirstSelected
Moves to the first record of the multiple selection in the business component.

var myBusComp;
var bIsMultipleSelection;
bIsMultipleSelection =
myBusComp.FirstSelected();
GetAssocBusComp
Returns the association business component.

var myBusComp;
var AssocBusComp;
AssocBusComp = myBusComp.GetAssocBusComp();
GetFieldValue
Returns a value for the field specified in the argument.

var myBusComp;
var sValue
sValue = myBusComp.GetFieldValue(FieldName);
GetFormattedFieldValue
Returns a formatted value for the field specified in the argument.

var myBusComp;
var sValue;
sValue = myBusComp.GetFormattedFieldValue(FieldName);
GetMultipleFieldValues
Returns a value for the fields specified in the property set.

var myBusComp;
myBusComp.GetMultipleFieldValues(oFields, oValues );
GetMVGBusComp
Returns the MVG business component associated with the field specified in the argument.

var myBusComp;
var MvgBusComp;
MvgBusComp= myBusComp.GetMVGBusComp(FieldName);
GetNamedSearch
Returns the named search specification specified in the argument.

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

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

var myBusComp;
var pickBusComp;
pickBusComp = myBusComp.GetPicklistBusComp(FieldName);
GetSearchExpr
Returns the current search expression.

var myBusComp;
var sExpr;
sExpr = myBusComp.GetSearchExpr()
GetSearchSpec
Returns the current search specification for the field specified in the argument.

var myBusComp;
var sSpec;
sSpec = myBusComp.GetSearchSpec(FieldName);
GetUserProperty
Returns the value for a property name specified in the argument.

var myBusComp;
var sValue;
sValue = myBusComp.GetUserProperty(propertyName);
GetViewMode
Returns the visibility mode for the business component.

var myBusComp;
var iMode;
iMode = myBusComp.GetViewMode();
InvokeMethod
Calls the specialized method named in the argument.

var myBusComp;
var sReturn;
sReturn = myBusComp.InvokeMethod(methodName, methodArg1, methodArg2,..., methodArgn);
LastRecord
Moves to the last record in the business component.

var myBusComp;
var iReturn;
iReturn = myBusComp.LastRecord();
Name
Returns the name of the business component.

var myBusComp;
var sName;
sName = myBusComp.Name();
NewRecord
Adds a new record to the business component.

var myBusComp;
myBusComp.NewRecord(whereIndicator);
NextRecord
Moves to the next record in the business component.

var myBusComp;
var bFound;
bFound = myBusComp.NextRecord();
NextSelected
Moves to the next record of the current multiple selection.

var myBusComp;
var iReturn;
iReturn = myBusComp.NextSelected();
ParentBusComp
Returns the parent business component.

var myBusComp;
var parentBusComp;
parentBusComp = myBusComp.ParentBusComp();
Pick
Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.

var myBusComp;
myBusComp.Pick();
PreviousRecord
Moves to the previous record in the business component.

var myBusComp;
var iReturn;
iReturn = myBusComp.PreviousRecord();
RefineQuery
Refines a query after a query has been executed.

var myBusComp;
myBusComp.RefineQuery();
SetFieldValue
Assigns a new value to the named field for the current row of the business component.

var myBusComp;
myBusComp.SetFieldValue(FieldName, FieldValue);
SetFormattedFieldValue
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
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
Sets a named search specification on the business component.

var myBusComp;
myBusComp.SetNamedSearch(searchName, searchSpec);
SetSearchExpr
Sets the search specification for the business component.

var myBusComp;
myBusComp.SetSearchExpr(searchSpec);
SetSearchSpec
Sets the search specification for the specified field.

var myBusComp;
myBusComp.SetSearchSpec(FieldName, searchSpec);
SetSortSpec
Sets the sort specification for a query.

var myBusComp;
myBusComp.SetSortSpec(sortSpec);
SetUserProperty
Sets the value of the specified User Property.

var myBusComp;
myBusComp.SetUserProperty(propertyName, newValue);
SetViewMode
Sets the visibility type for the business component.

var myBusComp;
myBusComp.SetViewMode(viewMode);
UndoRecord
Deletes an active record created by NewRecord.

var myBusComp;
myBusComp.UndoRecord();
WriteRecord
Commits to the database any changes made to the current record.

var myBusComp;
myBusComp.WriteRecord();

Table 83 lists a summary of the Business Components Events syntax.

Table 83.  Business Component Events Syntax Summary
Event
Description
Syntax
BusComp_Associate
Called after a record is added to a business component to create an association.

BusComp_Associate();
BusComp_ChangeRecord
Called after the current row changes in the business component.

BusComp_ChangeRecord();
BusComp_CopyRecord
Called after a new row is copied in the business component.

BusComp_CopyRecord();
BusComp_DeleteRecord
Called after a row is deleted in the business component.

BusComp_DeleteRecord();
BusComp_InvokeMethod
Called when the value of a business component field is accessed.

BusComp_InvokeMethod(methodName,methodArg1, methodArg2,..., methodArgn);
BusComp_NewRecord
Called after a new row has been created and made active in the business component.

BusComp_NewRecord();
BusComp_PreAssociate
Called before a record is added to a business component to create an association.

BusComp_PreAssociate();
BusComp_PreCopyRecord
Called before a new row is copied in the business component.

BusComp_PreCopyRecord();
BusComp_PreDeleteRecord
Called before a row is deleted in the business component.

BusComp_PreDeleteRecord();
BusComp_PreGetFieldValue
Called when the value of the business component field is accessed.

BusComp_PreGetFieldValue(FieldName, &FieldValue);
BusComp_PreInvokeMethod
Called before a specialized method is invoked on a business component.

BusComp_PreInvokeMethod(methodName);
BusComp_PreNewRecord
Called before a new row is created in the business component.

BusComp_PreNewRecord();
BusComp_PreQuery
Called before query execution.

BusComp_PreQuery();
BusComp_PreSetFieldValue
Called when a value is pushed down into the business component from the user interface.

BusComp_PreSetFieldValue(FieldName, FieldValue);
BusComp_PreWriteRecord
Called before a row is written out to the database.

BusComp_PreWriteRecord();
BusComp_Query
Called after the query is complete and every row has been retrieved, but before they have been displayed.

BusComp_Query();
BusComp_SetFieldValue
Called after a value has been pushed down into the business component from the user interface.

BusComp_SetFieldValue(FieldName);

BusComp_WriteRecord
Called after a row is written to the database.

BusComp_WriteRecord();


 Siebel Object Interfaces Reference 
 Published: 18 June 2003