Business Component Methods for COM Data Server

The following table describes a summary of the business component methods you can use with the COM Data Server. It does not include object interface methods that Siebel CRM calls with the InvokeMethod method. For information about methods that Siebel CRM calls with the InvokeMethod method on a business component, see Business Component Invoke Methods.

Method	Description	Format
ActivateField Method for a Business Component	Activates a field.	Dim busComp as SiebelBusComp busComp.ActivateField(fieldName as String, ErrCode as Integer)
ActivateMultipleFields Method for a Business Component	Activates multiple fields.	Dim buscomp as SiebelBusComp buscomp.ActivateMultipleFields(oPropSet as SiebelPropertySet, ErrCode as Integer)
Associate Method for a Business Component	Creates a new many-to-many relationship for the parent object through an association business component.	Dim busComp as SiebelBusComp busComp.Associate(whereIndicator as Integer, ErrCode as Integer)
BusObject Method for a Business Component	Returns the name of the business object that the business component references.	Dim busComp as SiebelBusComp Dim busObject as BusObject Set busObject = busComp.BusObject(ErrCode as Integer)
ClearToQuery Method for a Business Component	Clears the current query but does not clear sort specifications on a business component.	Dim busComp as SiebelBusComp busComp.ClearToQuery(ErrCode as Integer)
DeactivateFields Method for a Business Component	Deactivates the fields that are currently active from the SQL query statement of a business component.	Dim busComp as SiebelBusComp busComp.DeactivateFields(ErrCode as Integer)
DeleteRecord Method for a Business Component	Removes the current record from a business component.	Dim busComp as SiebelBusComp busComp.DeleteRecord(ErrCode as Integer)
ExecuteQuery Method for a Business Component	Returns a set of business component records.	Dim busComp as SiebelBusComp busComp.ExecuteQuery(cursorMode as Boolean, ErrCode 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 busComp as SiebelBusComp busComp.ExecuteQuery2(cursorMode as Boolean, ignoreMaxCursorSize as Boolean, ErrCode 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 busComp as SiebelBusComp Dim bIsRecord as Boolean bIsRecord = busComp.FirstRecord(ErrCode as Integer)
FirstSelected Method for a Business Component	Makes the first record of the multiple selection in a business component active.	Dim busComp as SiebelBusComp Dim iRecord as Integer iRecord = busComp.FirstSelected
GetAssocBusComp Method for a Business Component	Returns the name of the association business component.	Dim busComp as SiebelBusComp Dim AssocBusComp as BusComp Set AssocBusComp = busComp.GetAssocBusComp(ErrCode as Integer)
GetFieldValue Method for a Business Component	Returns the value of a field from the current record of a business component.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFieldValue(FieldName as String, ErrCode as Integer)
GetFormattedFieldValue Method for a Business Component	Returns a field value that is in the same format that the Siebel client uses.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFormattedFieldValue(FieldName as String, ErrCode as Integer)
GetMultipleFieldValues Method for a Business Component	Returns a value for each field specified in a property set.	Dim buscomp as SiebelBusComp Dim retValue as Boolean retValue = buscomp.GetMultipleFieldValues(oPropSetName as SiebelPropertySet, oPropSetValue as SiebelPropertySet, ErrCode as Integer)
GetMVGBusComp Method for a Business Component	Returns the multivalue group business component that is associated a business component field.	Dim busComp as SiebelBusComp Dim mVGBusComp as SiebelBusComp set mVGBusComp = busComp.GetMVGBusComp(FieldName as String, ErrCode as Integer)
GetNamedSearch Method for a Business Component	Returns the name of a search specification.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetNamedSearch(SearchName as String, ErrCode as Integer)
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 busComp as SiebelBusComp Dim pickBusComp as SiebelBusComp Set pickBusComp = busComp.GetPicklistBusComp(FieldName as String, ErrCode as Integer)
GetSearchExpr Method for a Business Component	Returns the current search expression that is defined for a business component.	Dim busComp as SiebelBusComp Dim sExpr as String sExpr = busComp.GetSearchExpr(ErrCode as Integer)
GetSearchSpec Method for a Business Component	Returns the search specification that is defined for a business component.	Dim busComp as BusComp Dim sSpec as String sSpec = busComp.GetSearchSpec(FieldName as String, ErrCode as Integer)
GetUserProperty Method for a Business Component	Returns the value of a user property.	Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetUserProperty(propertyName as String, ErrCode as Integer)
GetViewMode Method for a Business Component	Returns the visibility mode for a business component.	Dim busComp as SiebelBusComp Dim iMode as Integer iMode = busComp.GetViewMode(ErrCode as Integer)
LastRecord Method for a Business Component	Moves the record pointer to the last record in a business component.	Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.LastRecord(ErrCode as Integer)
Name Method for a Business Component	Returns the name of a business component.	Dim busComp as SiebelBusComp Dim sName as String sName = busComp.Name(ErrCode as Integer)
NewRecord Method for a Business Component	Adds a new record to a business component.	Dim busComp as SiebelBusComp busComp.NewRecord(whereIndicator as Integer, ErrCode 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 busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.NextRecord(ErrCode as Integer)
ParentBusComp Method for a Business Component	Returns the name of a parent business component.	Dim busComp as SiebelBusComp Dim parentBusComp as SiebelBusComp Set parentBusComp = busComp.ParentBusComp(ErrCode as Integer)
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 busComp as SiebelBusComp busComp.Pick(ErrCode as Integer)
PreviousRecord Method for a Business Component	Moves the record pointer to the previous record in a business component, making that record the current record.	Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.PreviousRecord(ErrCode as Integer)
RefineQuery Method for a Business Component	Refines a query.	Dim busComp as SiebelBusComp busComp.RefineQuery(ErrCode as Integer)
SetFieldValue Method for a Business Component	Sets a new value in a field for the current record of a business component.	Dim busComp as SiebelBusComp SetFieldValue(fieldname As String, fieldValue As string,errCode as Integer)
SetFormattedFieldValue Method for a Business Component	Sets a new value in a field in the current record of a business component. It accepts the field value in the current local format.	Dim busComp as SiebelBusComp busComp.SetFormattedFieldValue(FieldName as String, FieldValue as String, ErrCode as Integer)
SetMultipleFieldValues Method for a Business Component	Sets new values in the fields of the current record of a business component.	Dim buscomp as SiebelBusComp buscomp.SetMultipleFieldValues(oPropSet as SiebelPropertySet, ErrCode as Integer)
SetNamedSearch Method for a Business Component	Sets a named search specification on a business component.	Dim busComp as SiebelBusComp busComp.SetNamedSearch(searchName as String, searchSpec as String, ErrCode as Integer)
SetSearchExpr Method for a Business Component	Sets a search expression for a business component.	Dim busComp as SiebelBusComp busComp.SetSearchExpr(searchSpec as String, ErrCode as Integer)
SetSearchSpec Method for a Business Component	Sets the search specification for a business component.	Dim busComp as SiebelBusComp busComp.SetSearchSpec(FieldName as String, searchSpec as String, ErrCode as Integer)
SetSortSpec Method for a Business Component	Sets the sort specification for a business component.	Dim busComp as SiebelBusComp busComp.SetSortSpec(sortSpec as String, ErrCode as Integer)
SetUserProperty Method for a Business Component	Sets the value of a user property in a business component.	Dim busComp as SiebelBusComp busComp.SetUserProperty(propertyName as String, newValue as String, ErrCode as Integer)
SetViewMode Method for a Business Component	Sets the visibility type for a business component.	Dim buscomp as SiebelBusComp buscomp.SetViewMode(mode As Integer, errCode As Integer)
UndoRecord Method for a Business Component	Reverses any unsaved modifications made to the record.	Dim busComp as SiebelBusComp busComp.UndoRecord(ErrCode as Integer)
WriteRecord Method for a Business Component	Saves to the Siebel database any modifications made to the current record.	Dim busComp as SiebelBusComp busComp.WriteRecord(ErrCode as Integer)