Bookshelf v7.8: Business Component Objects

A business component defines the structure, the behavior, and the information displayed by a particular subject, such as a product, contact, or account. Siebel business components are logical abstractions of one or more database tables. The information stored in a business component is usually specific to a particular subject and is typically not dependent on other business components. Business components can be used in one or more business objects.

Business component objects have associated data structured as records, they have properties, and they contain data units called fields. In Siebel eScript, fields are accessed through business components. The business component object supports getting and setting field values, moving backward and forward through data in a business component object, and filtering changes to data it manages.

Methods of business component objects are documented in the Siebel Object Interfaces Reference.

Table 30. Business Component Object Methods and Events
Method or Event	Description
ActivateField() Method	ActivateField() allows setting search specifications and queries to retrieve data for the field specified in its parameter.
ActivateMultipleFields() Method	ActivateMultipleFields() allows the script to do ActivateField() for many fields at one time. These fields are listed in a property set.
Associate() Method	The Associate() method creates a new many-to-many relationship for the parent object through an association business component (see GetAssocBusComp() Method).
BusComp_Associate() Event	The Associate() event is called after a record has been added to a business component to create an association.
BusComp_ChangeRecord() Event	The ChangeRecord() event is called when a business component changes its current record from one record to another, for example when a user changes the record focus in an applet or when a script calls the NextRecord() method.
BusComp_CopyRecord() Event	The CopyRecord() event is called after a row has been copied in the business component and that row has been made active.
BusComp_DeleteRecord() Event	The DeleteRecord() event is called after a row is deleted. The current context moves to a different row because the Fields of the just-deleted row are no longer available.
BusComp_InvokeMethod() Event	The InvokeMethod() event is called when the InvokeMethod method is called on a business component.
BusComp_NewRecord() Event	The NewRecord() event is called after a new row has been created in the business component and that row has been made active. The event may be used to set up default values for Fields.
BusComp_PreAssociate() Event	The PreAssociate() event is called before a record is added to a business component to create an association. The semantics are the same as BusComp_PreNewRecord.
BusComp_PreCopyRecord() Event	The PreCopyRecord() event is called before a new row is copied in the business component. The event may be used to perform precopy validation.
BusComp_PreDeleteRecord() Event	The PreDeleteRecord event is called before a row is deleted in the business component. The event may be used to prevent the deletion or to perform any actions in which you need access to the record that is to be deleted.
BusComp_PreGetFieldValue() Event	The PreGetFieldValue() event is called when the value of a business component field is accessed.
BusComp_PreInvokeMethod() Event	The PreInvokeMethod() event is called before a specialized method is invoked on the business component.
BusComp_PreNewRecord() Event	The PreNewRecord event is called before a new row is created in the business component. The event may be used to perform preinsert validation.
BusComp_PreQuery() Event	The PreQuery() event is called before query execution.
BusComp_PreSetFieldValue() Event	The PreSetFieldValue() event is called before a value is pushed down into the business component from the user interface or through a call to SetFieldValue.
BusComp_PreWriteRecord() Event	The PreWriteRecord() event is called before a row is written out to the database. The event may perform any final validation necessary before the actual save occurs.
BusComp_Query() Event	The Query() event is called just after the query is completed and the rows have been retrieved but before the rows are actually displayed.
BusComp_SetFieldValue() Event	The SetFieldValue() event is called when a value is pushed down into the business component from the user interface or through a call to SetFieldValue.
BusComp_WriteRecord() Event	The WriteRecord event is called after a row is written out to the database.
BusObject() Method	The BusObject() method returns the business object that contains the business component.
ClearToQuery() Method	The ClearToQuery() method clears the current query and sort specifications on the business component.
DeactivateFields() Method	DeactivateFields deactivates the fields that are currently active from a business component SQL query statement.
DeleteRecord() Method	DeleteRecord() deletes the current business component record from the database.
ExecuteQuery() Method	ExecuteQuery() returns a set of business component records using the criteria established with methods such as SetSearchSpec.
ExecuteQuery2() Method	ExecuteQuery2() returns a set of business component records using the criteria established with methods such as SetSearchSpec. ExecuteQuery2() is an SQL-Server specific version of ExecuteQuery().
FirstRecord() Method	FirstRecord() moves the record pointer to the first record in a business component, making that record current and invoking any associated script events.
GetAssocBusComp() Method	GetAssocBusComp() returns the association business component. The association business component can be used to operate on the association using the normal business component mechanisms.
GetFieldValue() Method	GetFieldValue() returns the value for the field specified in its parameter for the current record of the business component. Use this method to access a field value.
GetFormattedFieldValue() Method	GetFormattedFieldValue returns the value for the field specified in its parameter in the current local format; that is, it returns values in the format in which they appear in the Siebel user interface.
GetMultipleFieldValues() Method	GetMultipleFieldValues() is used in scripts and effectively performs many GetFieldValue() calls using a list of fields specified in a property set.
GetMVGBusComp() Method	GetMVGBusComp() returns the MVG business component associated with the business component field specified by FieldName. This business component can be used to operate on the Multi-Value Group using the normal business component mechanisms.
GetNamedSearch() Method	GetNamedSearch() returns the named search specification specified by searchName.
GetPicklistBusComp() Method	GetPicklistBusComp() returns the pick business component associated with the specified field in the current business component.
GetSearchExpr() Method	GetSearchExpr() returns the current search expression for the business component.
GetSearchSpec() Method	GetSearchSpec() returns the search specification for the field specified by the fieldName parameter.
GetUserProperty() Method	GetUserProperty() returns the value of a named UserProperty.
GetViewMode() Method	GetViewMode() returns the current visibility mode for the business component. This method affects which records are returned by queries according to the visibility rules.
InvokeMethod() Method	InvokeMethod calls the specialized method or user-created method named in its parameter.
LastRecord() Method	LastRecord() moves to the last record in the business component.
Name() Method	The Name() method returns the name of the business component.
NewRecord() Method	NewRecord() adds a new record (row) to the business component.
NextRecord() Method	NextRecord() moves the record pointer to the next record in the business component, making that the current record and invoking any associated script events.
ParentBusComp() Method	ParentBusComp() returns the parent (master) business component when given the child (detail) business component of a link.
Pick() Method	The Pick() method places the currently selected record in a picklist business component into the appropriate fields of the parent business component. See also GetPicklistBusComp() Method.
PreviousRecord() Method	PreviousRecord() moves to the previous record in the business component, invoking any associated script events.
RefineQuery() Method	This method refines a query after the query has been executed.
SetFieldValue() Method	SetFieldValue() assigns the new value to the named field for the current row of the business component.
SetFormattedFieldValue() Method	SetFormattedFieldValue() assigns the new value to the named field for the current row of the business component. SetFormattedFieldValue accepts the field value in the current local format.
SetMultipleFieldValues() Method	SetMultipleFieldValues() is used in scripts and effectively performs many SetFieldValue() calls using a list of fields specified in a property set.
SetNamedSearch() Method	SetNamedSearch() sets a named search specification on the business component. A named search specification is identified by the searchName parameter.
SetSearchExpr() Method	SetSearchExpr() sets one search expression with many fields for the whole business component, rather than setting one search specification for each field.
SetSearchSpec() Method	SetSearchSpec() sets the search specification for a particular field. This method must be called before ExecuteQuery.
SetSortSpec() Method	SetSortSpec() sets the sorting specification for a query.
SetUserProperty() Method	SetUserProperty() sets the value of a named business component UserProperty. The User Properties are similar to instance variables of a BusComp.
SetViewMode() Method	SetViewMode() sets the visibility type for the business component.
UndoRecord() Method	UndoRecord() reverses any changes made to the record that are not committed. This reversal includes reversing uncommitted modifications to any fields, as well as deleting an active record that has not yet been committed to the database.
WriteRecord() Method	WriteRecord() commits to the database any changes made to the current record.