Table 31. Business Component Methods Syntax Summary
Method
|
Description
|
Syntax
|
|
|
Allows queries to retrieve data for the specified field.
|
Dim busComp as SiebelBusComp
busComp.ActivateField(fieldName as String, ErrCode as Integer)
|
|
|
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)
|
|
|
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)
|
|
|
Returns the business object that contains the business component.
|
Dim busComp as SiebelBusComp
Dim busObject as BusObject
Set busObject = busComp.BusObject(ErrCode as Integer)
|
|
|
Clears the current query and sort specifications on the business component.
|
Dim busComp as SiebelBusComp
busComp.ClearToQuery(ErrCode as Integer)
|
|
|
Deactivates every currently activated field.
|
Dim busComp as SiebelBusComp
busComp.DeactivateFields(ErrCode as Integer)
|
|
|
Removes the current record from the business component.
|
Dim busComp as SiebelBusComp
busComp.DeleteRecord(ErrCode as Integer)
|
|
|
Retrieves a set of BusComp records.
|
Dim busComp as SiebelBusComp
busComp.ExecuteQuery(cursorMode as Boolean, ErrCode as Integer)
|
|
|
Retrieves a set of BusComp records.
|
Dim busComp as SiebelBusComp
busComp.ExecuteQuery2(cursorMode as Boolean, ignoreMaxCursorSize as Boolean, ErrCode as Integer)
|
|
|
Moves to the first record in the business component.
|
Dim busComp as SiebelBusComp
Dim bIsRecord as Boolean
bIsRecord = busComp.FirstRecord(ErrCode as Integer)
|
|
|
Returns the association business component.
|
Dim busComp as SiebelBusComp
Dim AssocBusComp as BusComp
Set AssocBusComp = busComp.GetAssocBusComp(ErrCode as Integer)
|
|
|
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)
|
|
|
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)
|
|
|
Returns a value for the fields specified in the property set.
|
Dim buscomp as SiebelBusComp
buscomp.GetMultipleFieldValues(oPropSet as SiebelPropertySet, ErrCode as Integer)
|
|
|
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)
|
|
|
Returns the argument-named search specification.
|
Dim busComp as SiebelBusComp
Dim sValue as String
sValue = busComp.GetNamedSearch(SearchName as String, ErrCode as Integer)
|
|
|
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)
|
|
|
Returns the current search expression.
|
Dim busComp as SiebelBusComp
Dim sExpr as String
sExpr = busComp.GetSearchExpr(ErrCode as Integer)
|
|
|
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)
|
|
|
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)
|
|
|
Returns the visibility mode for the business component.
|
Dim busComp as SiebelBusComp
Dim iMode as Integer
iMode = busComp.GetViewMode(ErrCode as Integer)
|
|
|
Moves to the last record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.LastRecord(ErrCode as Integer)
|
|
|
Returns the name of the business component.
|
Dim busComp as SiebelBusComp
Dim sName as String
sName = busComp.Name(ErrCode as Integer)
|
|
|
Adds a new record to the business component.
|
Dim busComp as SiebelBusComp
busComp.NewRecord(whereIndicator as Integer, ErrCode as Integer)
|
|
|
Moves to the next record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.NextRecord(ErrCode as Integer)
|
|
|
Returns the parent business component.
|
Dim busComp as SiebelBusComp
Dim parentBusComp as SiebelBusComp
Set parentBusComp = busComp.ParentBusComp(ErrCode as Integer)
|
|
|
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)
|
|
|
Moves to the previous record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.PreviousRecord(ErrCode as Integer)
|
|
|
Refines a query after a query has been executed.
|
Dim busComp as SiebelBusComp
busComp.RefineQuery(ErrCode as Integer)
|
|
|
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)
|
|
|
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)
|
|
|
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)
|
|
|
Sets a named search specification on the business component.
|
Dim busComp as SiebelBusComp
busComp.SetNamedSearch(searchName as String, searchSpec as String, ErrCode as Integer)
|
|
|
Sets the search specification for the business component.
|
Dim busComp as SiebelBusComp
busComp.SetSearchExpr(searchSpec as String, ErrCode as Integer)
|
|
|
Sets the search specification for the specified field.
|
Dim busComp as SiebelBusComp
busComp.SetSearchSpec(FieldName as String, searchSpec as String, ErrCode as Integer)
|
|
|
Sets the sort specification for a query.
|
Dim busComp as SiebelBusComp
busComp.SetSortSpec(sortSpec as String, ErrCode as Integer)
|
|
|
Sets the value of the specified User Property.
|
Dim busComp as SiebelBusComp
busComp.SetUserProperty(propertyName as String, newValue as String, ErrCode as Integer)
|
|
|
Sets the visibility type for the business component.
|
SetViewMode(mode As Integer, errCode As Integer)
|
|
|
Deletes an active record created by NewRecord.
|
Dim busComp as SiebelBusComp
busComp.UndoRecord(ErrCode as Integer)
|
|
|
Commits to the database any changes made to the current record
|
Dim busComp as SiebelBusComp
busComp.WriteRecord(ErrCode as Integer)
|
