Table 42. Business Component Methods Syntax Summary
|
|
|
ActivateField Method |
Allows queries to retrieve data for the specified field. |
Dim busComp as SiebelBusComp busComp.ActivateField(fieldName as String, ErrCode as Integer)
|
ActivateMultipleFields Method |
Allows queries to retrieve data for the fields specified in the property set. |
Dim buscomp as SiebelBusComp buscomp.ActivateMultipleFields(oPropSet as SiebelPropertySet, ErrCode as Integer)
|
Associate Method |
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 |
Returns the business object that contains the business component. |
Dim busComp as SiebelBusComp Dim busObject as BusObject Set busObject = busComp.BusObject(ErrCode as Integer)
|
ClearToQuery Method |
Clears the current query and sort specifications on the business component. |
Dim busComp as SiebelBusComp busComp.ClearToQuery(ErrCode as Integer)
|
DeactivateFields Method |
Deactivates every currently activated field. |
Dim busComp as SiebelBusComp busComp.DeactivateFields(ErrCode as Integer)
|
DeleteRecord Method |
Removes the current record from the business component. |
Dim busComp as SiebelBusComp busComp.DeleteRecord(ErrCode as Integer)
|
ExecuteQuery Method |
Retrieves a set of BusComp records. |
Dim busComp as SiebelBusComp busComp.ExecuteQuery(cursorMode as Boolean, ErrCode as Integer)
|
ExecuteQuery2 Method |
Retrieves a set of BusComp records. |
Dim busComp as SiebelBusComp busComp.ExecuteQuery2(cursorMode as Boolean, ignoreMaxCursorSize as Boolean, ErrCode as Integer)
|
FirstRecord Method |
Moves to the first record in the business component. |
Dim busComp as SiebelBusComp Dim bIsRecord as Boolean bIsRecord = busComp.FirstRecord(ErrCode as Integer)
|
FirstSelected Method |
Moves to the first record of the multiple selection in the business component. |
Dim busComp as SiebelBusComp Dim iRecord as Integer iRecord = busComp.FirstSelected
|
GetAssocBusComp Method |
Returns the association business component. |
Dim busComp as SiebelBusComp Dim AssocBusComp as BusComp Set AssocBusComp = busComp.GetAssocBusComp(ErrCode as Integer)
|
GetFieldValue Method |
Returns a value for the field specified in the argument. |
Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFieldValue(FieldName as String, ErrCode as Integer)
|
GetFormattedFieldValue Method |
Returns a formatted value for the field specified in the argument. |
Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetFormattedFieldValue(FieldName as String, ErrCode as Integer)
|
GetMultipleFieldValues Method |
Returns a value for the fields specified in the property set. |
Dim buscomp as SiebelBusComp Dim retValue as Boolean retValue = buscomp.GetMultipleFieldValues(oPropSetName as SiebelPropertySet, oPropSetValue as SiebelPropertySet, ErrCode as Integer)
|
GetMVGBusComp Method |
Returns the MVG business component associated with the field specified in the argument. |
Dim busComp as SiebelBusComp Dim mVGBusComp as SiebelBusComp set mVGBusComp = busComp.GetMVGBusComp(FieldName as String, ErrCode as Integer)
|
GetNamedSearch Method |
Returns the argument-named search specification. |
Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetNamedSearch(SearchName as String, ErrCode as Integer)
|
GetPicklistBusComp Method |
Returns the pick business component associated with the field specified in the argument. |
Dim busComp as SiebelBusComp Dim pickBusComp as SiebelBusComp Set pickBusComp = busComp.GetPicklistBusComp(FieldName as String, ErrCode as Integer)
|
GetSearchExpr Method |
Returns the current search expression. |
Dim busComp as SiebelBusComp Dim sExpr as String sExpr = busComp.GetSearchExpr(ErrCode as Integer)
|
GetSearchSpec Method |
Returns the current search specification for the field specified in the argument. |
Dim busComp as BusComp Dim sSpec as String sSpec = busComp.GetSearchSpec(FieldName as String, ErrCode as Integer)
|
GetUserProperty Method |
Returns the value for the property name whose name is specified in the argument. |
Dim busComp as SiebelBusComp Dim sValue as String sValue = busComp.GetUserProperty(propertyName as String, ErrCode as Integer)
|
GetViewMode Method |
Returns the visibility mode for the business component. |
Dim busComp as SiebelBusComp Dim iMode as Integer iMode = busComp.GetViewMode(ErrCode as Integer)
|
LastRecord Method |
Moves to the last record in the business component. |
Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.LastRecord(ErrCode as Integer)
|
Name Method |
Returns the name of the business component. |
Dim busComp as SiebelBusComp Dim sName as String sName = busComp.Name(ErrCode as Integer)
|
NewRecord Method |
Adds a new record to the business component. |
Dim busComp as SiebelBusComp busComp.NewRecord(whereIndicator as Integer, ErrCode as Integer)
|
NextRecord Method |
Moves to the next record in the business component. |
Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.NextRecord(ErrCode as Integer)
|
ParentBusComp Method |
Returns the parent business component. |
Dim busComp as SiebelBusComp Dim parentBusComp as SiebelBusComp Set parentBusComp = busComp.ParentBusComp(ErrCode as Integer)
|
Pick Method |
Places the currently selected record in a picklist business component into the appropriate fields of the parent business component. |
Dim busComp as SiebelBusComp busComp.Pick(ErrCode as Integer)
|
PreviousRecord Method |
Moves to the previous record in the business component. |
Dim busComp as SiebelBusComp Dim bReturn as Boolean bReturn = busComp.PreviousRecord(ErrCode as Integer)
|
RefineQuery Method |
Refines a query after a query has been executed. |
Dim busComp as SiebelBusComp busComp.RefineQuery(ErrCode as Integer)
|
SetFieldValue Method |
Assigns a new value to the named field for the current row of the business component. |
Dim busComp as SiebelBusComp
SetFieldValue(fieldname As String, fieldValue As string,errCode as Integer)
|
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 busComp as SiebelBusComp busComp.SetFormattedFieldValue(FieldName as String, FieldValue as String, ErrCode as Integer)
|
SetMultipleFieldValues Method |
Assigns a new value to the fields specified in the property set for the current row of the business component. |
Dim buscomp as SiebelBusComp buscomp.SetMultipleFieldValues(oPropSet as SiebelPropertySet, ErrCode as Integer)
|
SetNamedSearch Method |
Sets a named search specification on the business component. |
Dim busComp as SiebelBusComp busComp.SetNamedSearch(searchName as String, searchSpec as String, ErrCode as Integer)
|
SetSearchExpr Method |
Sets the search specification for the business component. |
Dim busComp as SiebelBusComp busComp.SetSearchExpr(searchSpec as String, ErrCode as Integer)
|
SetSearchSpec Method |
Sets the search specification for the specified field. |
Dim busComp as SiebelBusComp busComp.SetSearchSpec(FieldName as String, searchSpec as String, ErrCode as Integer)
|
SetSortSpec Method |
Sets the sort specification for a query. |
Dim busComp as SiebelBusComp busComp.SetSortSpec(sortSpec as String, ErrCode as Integer)
|
SetUserProperty Method |
Sets the value of the specified User Property. |
Dim busComp as SiebelBusComp busComp.SetUserProperty(propertyName as String, newValue as String, ErrCode as Integer)
|
SetViewMode Method |
Sets the visibility type for the business component. |
Dim buscomp as SiebelBusComp buscomp.SetViewMode(mode As Integer, errCode As Integer)
|
UndoRecord Method |
Reverses any uncommitted changes made to the record. |
Dim busComp as SiebelBusComp busComp.UndoRecord(ErrCode as Integer)
|
WriteRecord Method |
Commits to the database any changes made to the current record |
Dim busComp as SiebelBusComp busComp.WriteRecord(ErrCode as Integer)
|