Siebel Object Interfaces Reference > Mobile Web Client Automation Server Quick Reference >

Business Component Methods for Mobile Web Client Automation Server


Table 32 lists a summary of the Business Component methods' syntax.

Table 32. Business Component Methods Syntax Summary
Method
Description
Syntax

ActivateField Method

Allows queries to retrieve data for the specified field.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = BusComp.ActivateField(fieldName as String)

ActivateMultipleFields Method

Allows queries to retrieve data for the fields specified in the property set.

Dim buscomp as SiebelBusComp
buscomp.ActivateMultipleFields(oPropSet as SiebelPropertySet)

Associate Method

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)

BusObject Method

Returns the business object that contains the business component.

Dim busComp as SiebelBusComp
Dim busObject as SiebelBusObject
Set BusObject = busComp.BusObject

ClearToQuery Method

Clears the current query and sort specifications on the business component.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ClearToQuery

DeactivateFields Method

Deactivates every currently activated field.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.DeactivateFields

DeleteRecord Method

Removes the current record from the business component.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.DeleteRecord

ExecuteQuery Method

Retrieves a set of BusComp records.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ExecuteQuery(cursorMode as Integer)

ExecuteQuery2 Method

Retrieves a set of BusComp records.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.ExecuteQuery2(cursorMode as Integer, ignoreMaxCursorSize as Boolean)

FirstRecord Method

Moves to the first record in the business component.

Dim busComp as SiebelBusComp
Dim bIsRecord as Boolean
bIsRecord = busComp.FirstRecord

GetAssocBusComp Method

Returns the association business component.

Dim busComp as SiebelBusComp
Dim AssocBusComp as SiebelBusComp
Set AssocBusComp = busComp.GetAssocBusComp

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)

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)

GetLastErrCode Method

Returns the last Siebel error number.

Dim buscomp as SiebelBusComp
Dim iErr as Integer
iErr = buscomp.GetLastErrCode

GetLastErrText Method

Returns the last error text message.

Dim busComp as SiebelBusComp
Dim sErr as String
sErr = busComp.GetLastErrText

GetMultipleFieldValues Method

Returns a value for the fields specified in the property set.

Dim buscomp as SiebelBusComp
buscomp.GetMultipleFieldValues(oPropSet as SiebelPropertySet, PValues as SiebelPropertySet)

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)

GetNamedSearch Method

Returns the argument-named search specification.

Dim busComp as SiebelBusComp
Dim sValue as String
sValue = busComp.GetNamedSearch(SearchName as String)

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)

GetSearchExpr Method

Returns the current search expression.

Dim busComp as SiebelBusComp
Dim sExpr as String
sExpr = busComp.GetSearchExpr

GetSearchSpec Method

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)

GetUserProperty Method

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)

GetViewMode Method

Returns the visibility mode for the business component.

Dim busComp as SiebelBusComp
Dim iMode as Integer
iMode = busComp.GetViewMode

InvokeMethod Method

Calls the specialized method named in the argument.

Dim busComp as SiebelBusComp
Dim sReturn as String
sReturn = busComp.InvokeMethod( methodName as String, methodArgs as String or StringArray)

LastRecord Method

Moves to the last record in the business component.

Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.LastRecord

Name Method

Returns the name of the business component.

Dim busComp as SiebelBusComp
Dim sName as String
sName = busComp.Name

NewRecord Method

Adds a new record to the business component.

Dim busComp as SiebelBusComp
Dim bool as Boolean
bool = busComp.NewRecord(whereIndicator as Integer)

NextRecord Method

Moves to the next record in the business component.

Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.NextRecord

ParentBusComp Method

Returns the parent business component.

Dim busComp as SiebelBusComp
Dim parentBusComp as SiebelBusComp
Set parentBusComp = busComp.ParentBusComp

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

PreviousRecord Method

Moves to the previous record in the business component.

Dim busComp as SiebelBusComp
Dim bReturn as Boolean
bReturn = busComp.PreviousRecord

RefineQuery Method

Refines a query after a query has been executed.

Dim busComp as SiebelBusComp
busComp.RefineQuery

SetFieldValue Method

Assigns a new value to the named field for the current row of the business component.

Dim busComp as SiebelBusComp
busComp.SetFieldValue(FieldName as String, FieldValue as String)

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)

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)

SetNamedSearch Method

Sets a named search specification on the business component.

Dim busComp as SiebelBusComp
busComp.SetNamedSearch(searchName as String, searchSpec as String)

SetSearchExpr Method

Sets the search expression for the business component.

Dim busComp as SiebelBusComp
busComp.SetSearchExpr(searchSpec as String)

SetSearchSpec Method

Sets the search specification for the specified field.

Dim busComp as SiebelBusComp
busComp.SetSearchSpec(FieldName as String, searchSpec as String)

SetSortSpec Method

Sets the sort specification for a query.

Dim busComp as SiebelBusComp
busComp.SetSortSpec(sortSpec as String)

SetUserProperty Method

Sets the value of the specified User Property.

Dim busComp as SiebelBusComp
busComp.SetUserProperty(propertyName as String, newValue as String)

SetViewMode Method

Sets the visibility type for the business component.

Dim buscomp as SiebelBusComp
buscomp.SetViewMode(mode As Integer)

UndoRecord Method

Reverses any uncommitted changes made to the record.

Dim busComp as SiebelBusComp
busComp.UndoRecord

WriteRecord Method

Commits to the database any changes made to the current record.

Dim busComp as SiebelBusComp
busComp.WriteRecord

Siebel Object Interfaces Reference