Business Component Methods for Siebel VB

The following table describes a summary of the business component methods you can use with Siebel VB. It does not include object interface methods that are not called directly from a business component. For information about methods that you can call with the InvokeMethod method on the business component, see Business Component Invoke Methods.

Method Description Format

ActivateField Method for a Business Component

Activates a field.

Dim oBusComp as BusComp

oBusComp.ActivateField fieldName as String

ActivateMultipleFields Method for a Business Component

Activates multiple fields.

Dim oBusComp as BusComp

oBusComp.ActivateMultipleFields

oPropSet as PropertySet

Associate Method for a Business Component

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 for a Business Component

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

Dim oBusComp as BusComp

Dim oBusObject as BusObject

Set oBusObject = oBusComp.BusObject

ClearToQuery Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.ClearToQuery

DeactivateFields Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.DeactivateFields

DeleteRecord Method for a Business Component

Removes the current record from a business component.

Dim oBusComp as BusComp

oBusComp.DeleteRecord

ExecuteQuery Method for a Business Component

Returns a set of business component records.

Dim oBusComp as BusComp

oBusComp.ExecuteQuery cursorMode as Integer

ExecuteQuery2 Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.ExecuteQuery2 cursorMode as Integer, ignoreMaxCursorSize as Integer

FirstRecord Method for a Business Component

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

Dim oBusComp as BusComp

Dim iIsRecord as Integer

iIsRecord = oBusComp.FirstRecord

FirstSelected Method for a Business Component

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

Dim oBusComp as BusComp

Dim iIsMultipleSection as Integer

iIsMultipleSelection = oBusComp.FirstSelected

GetAssocBusComp Method for a Business Component

Returns the name of the association business component.

Dim oBusComp as BusComp

Dim AssocBusComp as BusComp

Set AssocBusComp = oBusComp.GetAssocBusComp

GetFieldValue Method for a Business Component

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

Dim oBusComp as BusComp

Dim sValue as String

sValue = oBusComp.GetFieldValue(FieldName as String)

GetFormattedFieldValue Method for a Business Component

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

Dim oBusComp as BusComp

Dim sValue as String

sValue = oBusComp.GetFormattedFieldValue(FieldName as String)

GetMultipleFieldValues Method for a Business Component

Returns values for the fields specified in a property set.

Dim oBusComp as BusComp

oBusComp.GetMultipleFieldValues oFields as PropertySet, oValues as PropertySet

GetMVGBusComp Method for a Business Component

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

Dim oBusComp as BusComp

Dim MvgBusComp as BusComp

set MvgBusComp = oBusComp.GetMVGBusComp(FieldName as String)

GetNamedSearch Method for a Business Component

Returns the name of a search specification.

Dim oBusComp as BusComp

Dim sValue as String

sValue = oBusComp.GetNamedSearch(SearchName as String)

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.

Dim oBusComp as BusComp

Dim pickBusComp as BusComp

Set pickBusComp = oBusComp.GetPicklistBusComp(FieldName as String)

GetSearchExpr Method for a Business Component

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

Dim oBusComp as BusComp

Dim sExpr as String

sExpr = oBusComp.GetSearchExpr

GetSearchSpec Method for a Business Component

Returns the search specification for a field.

Dim oBusComp as BusComp

Dim sSpec as String

sSpec = oBusComp.GetSearchSpec(FieldName as String)

GetSortSpec Method for a Business Component

Returns the sort specification for a business component.

Dim sSortSpec as String

sSortSpec = GetSortSpec

GetUserProperty Method for a Business Component

Returns the value of a user property.

Dim oBusComp as BusComp

Dim sValue as String

sValue = oBusComp.GetUserProperty(propertyName as String)

GetViewMode Method for a Business Component

Returns the current visibility mode for a business component.

Dim oBusComp as BusComp

Dim iMode as Integer

iMode = oBusComp.GetViewMode

InvokeMethod Method for a Business Component

Calls a method.

Dim oBusComp as BusComp

oBusComp.InvokeMethod(methodName as String, methArg1, methArg2, methArgN as String or StringArray)

LastRecord Method for a Business Component

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

Dim oBusComp as BusComp

Dim iReturn as Integer

iReturn = oBusComp.LastRecord

Name Method for a Business Component

Returns the name of a business component.

Dim oBusComp as BusComp

Dim sName as String

sName = oBusComp.Name

NewRecord Method for a Business Component

Adds a new record to a business component.

Dim oBusComp as BusComp

oBusComp.NewRecord whereIndicator as Integer

NextRecord Method for a Business Component

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

Dim oBusComp as BusComp

Dim iReturn as Integer

iReturn = oBusComp.NextRecord

NextSelected Method for a Business Component

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

Dim oBusComp as BusComp

Dim iReturn as Integer

iReturn = oBusComp.NextSelected

ParentBusComp Method for a Business Component

Returns the name of the parent business component.

Dim oBusComp as BusComp

Dim parentBusComp as BusComp

Set parentBusComp = oBusComp.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.

Dim oBusComp as BusComp

oBusComp.Pick

PreviousRecord Method for a Business Component

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

Dim oBusComp as BusComp

Dim iReturn as Integer

iReturn = oBusComp.PreviousRecord

RefineQuery Method for a Business Component

Refines a query.

Dim oBusComp as BusComp

oBusComp.RefineQuery

SetFieldValue Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.SetFieldValue FieldName as String, FieldValue as String

SetFormattedFieldValue Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.SetFormattedFieldValue FieldName as String, FieldValue as String

SetMultipleFieldValues Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.SetMultipleFieldValues oPropSet as PropertySet

SetNamedSearch Method for a Business Component

Sets the named search specification on a business component.

Dim oBusComp as BusComp

oBusComp.SetNamedSearch searchName as String, searchSpec as String

SetSearchExpr Method for a Business Component

Sets a search expression for a business component rather than for each field.

Dim oBusComp as BusComp

oBusComp.SetSearchExpr searchSpec as String

SetSearchSpec Method for a Business Component

Sets the search specification for a field.

Dim oBusComp as BusCompoBusComp.SetSearchSpec fieldName as String, searchSpec as String

SetSortSpec Method for a Business Component

Sets the sort specification for a business component.

Dim oBusComp as BusComp

oBusComp.SetSortSpec sortSpec as String

SetUserProperty Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.SetUserProperty propertyName as String, newValue as String

SetViewMode Method for a Business Component

Sets the visibility type for a business component.

Dim oBusComp as BusComp

oBusComp.SetViewMode viewMode as Integer

UndoRecord Method for a Business Component

Reverses any unsaved modifications that Siebel CRM has made on a record.

Dim oBusComp as BusComp

oBusComp.UndoRecord

WriteRecord Method for a Business Component

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

Dim oBusComp as BusComp

oBusComp.WriteRecord