Table 36. Business Component Methods Syntax Summary
Method
|
Description
|
Syntax
|
|
|
Allows queries to retrieve data for the specified field.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = BusComp.ActivateField(fieldName as String)
|
|
|
Allows queries to retrieve data for the fields specified in the property set.
|
Dim buscomp as SiebelBusComp
buscomp.ActivateMultipleFields(oPropSet as SiebelPropertySet)
|
|
|
Creates a new many-to-many relationship for the parent object through an association business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.Associate(whereIndicator as Integer)
|
|
|
Returns the business object that contains the business component.
|
Dim busComp as SiebelBusComp
Dim busObject as SiebelBusObject
Set BusObject = busComp.BusObject
|
|
|
Clears the current query and sort specifications on the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ClearToQuery
|
|
|
Deactivates every currently activated field.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.DeactivateFields
|
|
|
Removes the current record from the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.DeleteRecord
|
|
|
Retrieves a set of BusComp records.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ExecuteQuery(cursorMode as Integer)
|
|
|
Retrieves a set of BusComp records.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ExecuteQuery2(cursorMode as Integer, ignoreMaxCursorSize as Integer)
|
|
|
Moves to the first record in the business component.
|
Dim busComp as SiebelBusComp
Dim bIsRecord as Boolean
bIsRecord = busComp.FirstRecord
|
|
|
Returns the association business component.
|
Dim busComp as SiebelBusComp
Dim AssocBusComp as SiebelBusComp
Set AssocBusComp = busComp.GetAssocBusComp
|
|
|
Returns a value for the field specified in the argument.
|
Dim busComp as SiebelBusComp
Dim sValue as String
sValue = busComp.GetFieldValue(FieldName as String)
|
|
|
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)
|
|
|
Returns the last Siebel error number.
|
Dim buscomp as SiebelBusComp
Dim bool as Integer
bool = buscomp.GetLastErrCode
|
|
|
Returns the last error text message.
|
Dim busComp as SiebelBusComp
Dim sErr as String
sErr = busComp.GetLastErrText
|
|
|
Returns a value for the fields specified in the property set.
|
Dim buscomp as SiebelBusComp
buscomp.GetMultipleFieldValues(oPropSet as SiebelPropertySet, PValues as SiebelPropertySet)
|
|
|
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)
|
|
|
Returns the argument-named search specification.
|
Dim busComp as SiebelBusComp
Dim sValue as String
sValue = busComp.GetNamedSearch(SearchName as String)
|
|
|
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)
|
|
|
Returns the current search expression.
|
Dim busComp as SiebelBusComp
Dim sExpr as String
sExpr = busComp.GetSearchExpr
|
|
|
Returns the current search specification for the field specified in the argument.
|
Dim busComp as SiebelBusComp
Dim sSpec as String
sSpec = busComp.GetSearchSpec(FieldName as String)
|
|
|
Returns the value for the property name specified in the argument.
|
Dim busComp as SiebelBusComp
Dim sValue as String
sValue = busComp.GetUserProperty(propertyName as String)
|
|
|
Returns the visibility mode for the business component.
|
Dim busComp as SiebelBusComp
Dim iMode as Integer
iMode = busComp.GetViewMode
|
|
|
Calls the specialized method named in the argument.
|
Dim busComp as SiebelBusComp
Dim sReturn as String
sReturn = busComp.InvokeMethod(methodName as String or StringArray, methodArgs as String)
|
|
|
Moves to the last record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.LastRecord
|
|
|
Returns the name of the business component.
|
Dim busComp as SiebelBusComp
Dim sName as String
sName = busComp.Name
|
|
|
Adds a new record to the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.NewRecord(whereIndicator as Integer)
|
|
|
Moves to the next record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.NextRecord
|
|
|
Returns the parent business component.
|
Dim busComp as SiebelBusComp
Dim parentBusComp as SiebelBusComp
Set parentBusComp = busComp.ParentBusComp
|
|
|
Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.Pick
|
|
|
Moves to the previous record in the business component.
|
Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.PreviousRecord
|
|
|
Refines a query after a query has been executed.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.RefineQuery
|
|
|
Assigns a new value to the named field for the current row of the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetFieldValue(FieldName as String, FieldValue as String)
|
|
|
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
Dim bool as Boolean
bool = busComp.SetFormattedFieldValue(FieldName as String, FieldValue as String)
|
|
|
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)
|
|
|
Sets a named search specification on the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetNamedSearch(searchName as String, searchSpec as String)
|
|
|
Sets the search specification for the business component.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetSearchExpr(searchSpec as String)
|
|
|
Sets the search specification for the specified field.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetSearchSpec(FieldName as String, searchSpec as String)
|
|
|
Sets the sort specification for a query.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetSortSpec(sortSpec as String)
|
|
|
Sets the value of the specified User Property.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.SetUserProperty(propertyName as String, newValue as String)
|
|
|
Sets the visibility type for the business component.
|
Dim buscomp as SiebelBusComp
Dim bool as Boolean
bool = buscomp.SetViewMode(mode As Integer)
|
|
|
Deletes an active record created by NewRecord.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.UndoRecord
|
|
|
Commits to the database any changes made to the current record.
|
Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.WriteRecord
|
