Siebel Object Interfaces Reference > Siebel VB Quick Reference >

Business Component Methods for Siebel VB


Table 49 lists a summary of the Business Component methods' syntax.

Table 49. Business Component Methods Syntax Summary
Method
Description
Syntax

ActivateField Method

Allows queries to retrieve data for the specified field.

Dim oBusComp as BusComp
oBusComp.ActivateField fieldName as String

ActivateMultipleFields Method

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

Dim oBusComp as BusComp
oBusComp.ActivateMultipleFields oPropSet as PropertySet

Associate Method

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

Dim oBusComp as BusComp
oBusComp.Associate whereIndicator as Integer

BusObject Method

Function that returns the business object that contains the business component.

Dim oBusComp as BusComp
Dim oBusObject as BusObject
Set oBusObject = oBusComp.BusObject

ClearToQuery Method

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

Dim oBusComp as BusComp
oBusComp.ClearToQuery

DeactivateFields Method

Deactivates every currently activated field.

Dim oBusComp as BusComp
oBusComp.DeactivateFields

DeleteRecord Method

Removes the current record from the business component.

Dim oBusComp as BusComp
oBusComp.DeleteRecord

ExecuteQuery Method

Retrieves a set of BusComp records.

Dim oBusComp as BusComp
oBusComp.ExecuteQuery cursorMode as Integer

ExecuteQuery2 Method

Retrieves a set of BusComp records.

Dim oBusComp as BusComp
oBusComp.ExecuteQuery2 cursorMode as Integer, ignoreMaxCursorSize as Integer

FirstRecord Method

Moves to the first record in the business component.

Dim oBusComp as BusComp
Dim iIsRecord as Integer
iIsRecord = oBusComp.FirstRecord

FirstSelected Method

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

Dim oBusComp as BusComp
Dim iIsMultipleSection as Integer
iIsMultipleSelection = oBusComp.FirstSelected

GetAssocBusComp Method

Function that returns the association business component.

Dim oBusComp as BusComp
Dim AssocBusComp as BusComp
Set AssocBusComp = oBusComp.GetAssocBusComp

GetFieldValue Method

Function that returns a value for the argument-specified field.

Dim oBusComp as BusComp
Dim sValue as String
sValue = oBusComp.GetFieldValue(FieldName as String)

GetFormattedFieldValue Method

Function that returns a formatted value for the argument-specified field.

Dim oBusComp as BusComp
Dim sValue as String
sValue = oBusComp.GetFormattedFieldValue(FieldName as String)

GetMultipleFieldValues Method

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

Dim oBusComp as BusComp
oBusComp.GetMultipleFieldValues oFields as PropertySet, oValues as PropertySet

GetMVGBusComp Method

Function that returns the MVG business component associated with the argument-specified field.

Dim oBusComp as BusComp
Dim MvgBusComp as BusComp
set MvgBusComp = oBusComp.GetMVGBusComp(FieldName as String)

GetNamedSearch Method

Function that returns the argument-named search specification.

Dim oBusComp as BusComp
Dim sValue as String
sValue = oBusComp.GetNamedSearch(SearchName as String)

GetPicklistBusComp Method

Function that returns the pick business component associated with the argument-specified field.

Dim oBusComp as BusComp
Dim pickBusComp as BusComp
Set pickBusComp = oBusComp.GetPicklistBusComp(FieldName as String)

GetSearchExpr Method

Function that returns the current search expression.

Dim oBusComp as BusComp
Dim sExpr as String
sExpr = oBusComp.GetSearchExpr

GetSearchSpec Method

Function that returns the current search specification for the argument-specified field.

Dim oBusComp as BusComp
Dim sSpec as String
sSpec = oBusComp.GetSearchSpec(FieldName as String)

GetUserProperty Method

Function that returns the value for an argument-specified property name.

Dim oBusComp as BusComp
Dim sValue as String
sValue = oBusComp.GetUserProperty(propertyName as String)

GetViewMode Method

Function that returns the visibility mode for the business component.

Dim oBusComp as BusComp
Dim iMode as Integer
iMode = oBusComp.GetViewMode

InvokeMethod Method

Calls the specialized method or user-created method specified in the argument.

Dim oBusComp as BusComp
Dim Return
Return = oBusComp.InvokeMethod(methodName as String, methodArgs as String or StringArray)

LastRecord Method

Moves to the last record in the business component.

Dim oBusComp as BusComp
Dim iReturn as Integer
iReturn = oBusComp.LastRecord

Name Method

Function that returns the name of the business component.

Dim oBusComp as BusComp
Dim sName as String
sName = oBusComp.Name

NewRecord Method

Adds a new record to the business component.

Dim oBusComp as BusComp
oBusComp.NewRecord(whereIndicator as Integer)

NextRecord Method

Moves to the next record in the business component.

Dim oBusComp as BusComp
Dim iReturn as Integer
iReturn = oBusComp.NextRecord

NextSelected Method

Moves to the next record of the current multiple selection.

Dim oBusComp as BusComp
Dim iReturn as Integer
iReturn = oBusComp.NextSelected

ParentBusComp Method

Function that returns the parent business component.

Dim oBusComp as BusComp
Dim parentBusComp as BusComp
Set parentBusComp = oBusComp.ParentBusComp

Pick Method

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

Dim oBusComp as BusComp
oBusComp.Pick

PreviousRecord Method

Moves to the previous record in the business component.

Dim oBusComp as BusComp
Dim iReturn as Integer
iReturn = oBusComp.PreviousRecord

RefineQuery Method

Refines a query after a query has been executed.

Dim oBusComp as BusComp
oBusComp.RefineQuery

SetFieldValue Method

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

Dim oBusComp as BusComp
oBusComp.SetFieldValue FieldName as String, FieldValue as String

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.

Dim oBusComp as BusComp
oBusComp.SetFormattedFieldValue FieldName as String, FieldValue as String

SetMultipleFieldValues Method

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

Dim oBusComp as BusComp
oBusComp.SetMultipleFieldValues oPropSet as PropertySet

SetNamedSearch Method

Sets a named search specification on the business component.

Dim oBusComp as BusComp
oBusComp.SetNamedSearch searchName as String, searchSpec as String

SetSearchExpr Method

Sets the entire search expression for the business component.

Dim oBusComp as BusComp
oBusComp.SetSearchExpr searchSpec as String

SetSearchSpec Method

Sets the search specification for the specified field.

Dim oBusComp as BusComp
oBusComp.SetSearchSpec fieldName as String, searchSpec as String )

SetSortSpec Method

Sets the sort specification for a query.

Dim oBusComp as BusComp
oBusComp.SetSortSpec sortSpec as String

SetUserProperty Method

Sets the value of the specified User Property.

Dim oBusComp as BusComp
oBusComp.SetUserProperty propertyName as String, newValue as String

SetViewMode Method

Sets the visibility type for the business component.

Dim oBusComp as BusComp
oBusComp.SetViewMode viewMode as Integer

UndoRecord Method

Reverses any uncommitted changes made to the record.

Dim oBusComp as BusComp
oBusComp.UndoRecord

WriteRecord Method

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

Dim oBusComp as BusComp
oBusComp.WriteRecord

Table 50 lists a summary of the Business Components Events.

Table 50. Business Component Events Summary
Event
Description
Syntax

BusComp_Associate Event

Called after a record is added to a business component to create an association.

BusComp_Associate

BusComp_ChangeRecord Event

Called after the current row changes in the business component.

BusComp_ChangeRecord

BusComp_CopyRecord Event

Called after a new row is copied in the business component.

BusComp_CopyRecord

BusComp_DeleteRecord Event

Called after a row is deleted in the business component.

BusComp_DeleteRecord

BusComp_InvokeMethod Event

Called after a custom or specialized method is called on a business component.

BusComp_InvokeMethod(methodName as String)

BusComp_NewRecord Event

Called after a new row has been created and made active in the business component.

BusComp_NewRecord

BusComp_PreAssociate Event

Called before a record is added to a business component to create an association.

BusComp_PreAssociate

BusComp_PreCopyRecord Event

Called before a new row is copied in the business component.

BusComp_PreCopyRecord

BusComp_PreDeleteRecord Event

Called before a row is deleted in the business component.

BusComp_PreDeleteRecord

BusComp_PreGetFieldValue Event

Called when the value of a business component field is accessed.

BusComp_PreGetFieldValue(FieldName as String, FieldValue as String)

BusComp_PreInvokeMethod Event

Called before a specialized or custom method is invoked on a business component.

BusComp_PreInvokeMethod(methodName as String)

BusComp_PreNewRecord Event

Called before a new row is created in the business component.

BusComp_PreNewRecord

BusComp_PreQuery Event

Called before query execution.

BusComp_PreQuery

BusComp_PreSetFieldValue Event

Called when a value is pushed down into the business component from the user interface or through a call to SetFieldValue.

BusComp_PreSetFieldValue(FieldName as String,FieldValue as String)

BusComp_PreWriteRecord Event

Called before a row is written out to the database.

BusComp_PreWriteRecord

BusComp_Query Event

Called after the query is complete and every row has been retrieved, but before they have been displayed.

BusComp_Query

BusComp_SetFieldValue Event

Called after a value has been pushed down into the business component from the user interface or through a call to SetFieldValue.

BusComp_SetFieldValue(fieldName as String)

BusComp_WriteRecord Event

Called after a row is written to the database.

BusComp_WriteRecord

Siebel Object Interfaces Reference