Table 82. Business Component Methods Syntax Summary
Method
|
Description
|
Syntax
|
|
Allows queries to retrieve data for the specified field.
|
var myBusComp; myBusComp.ActivateField(fieldName);
|
|
Allows queries to retrieve data for the fields specified in the property set.
|
var myBusComp; myBusComp.ActivateMultipleFields(oPropSet);
|
|
Creates a new many-to-many relationship for the parent object through an association business component.
|
var myBusComp; myBusComp.Associate(whereIndicator);
|
|
Returns the business object that contains the business component.
|
var myBusComp; var busObject; busObject = myBusComp.BusObject();
|
|
Clears the current query and sort specifications on the business component.
|
var myBusComp; myBusComp.ClearToQuery();
|
|
Deactivates every currently activated field.
|
var myBusComp; myBusComp.DeactivateFields();
|
|
Removes the current record from the business component.
|
var myBusComp; myBusComp.DeleteRecord()
|
|
Retrieves a set of BusComp records.
|
var myBusComp; myBusComp.ExecuteQuery(cursorMode);
|
|
Retrieves a set of BusComp records.
|
var myBusComp; myBusComp.ExecuteQuery2(cursorMode, ignoreMaxCursorSize);
|
|
Moves to the first record in the business component.
|
var myBusComp; var bIsRecord; bIsRecord = myBusComp.FirstRecord();
|
|
Moves to the first record of the multiple selection in the business component.
|
var myBusComp; var bIsMultipleSelection; bIsMultipleSelection = myBusComp.FirstSelected();
|
|
Returns the association business component.
|
var myBusComp; var AssocBusComp; AssocBusComp = myBusComp.GetAssocBusComp();
|
|
Returns a value for the field specified in the argument.
|
var myBusComp; var sValue sValue = myBusComp.GetFieldValue(FieldName);
|
|
Returns a formatted value for the field specified in the argument.
|
var myBusComp; var sValue; sValue = myBusComp.GetFormattedFieldValue(FieldName);
|
|
Returns a value for the fields specified in the property set.
|
var myBusComp; myBusComp.GetMultipleFieldValues(oFields, oValues );
|
|
Returns the MVG business component associated with the field specified in the argument.
|
var myBusComp; var MvgBusComp; MvgBusComp= myBusComp.GetMVGBusComp(FieldName);
|
|
Returns the named search specification specified in the argument.
|
var myBusComp; var sValue; sValue = myBusComp.GetNamedSearch(SearchName);
|
|
Returns the pick business component associated with the field specified in the argument.
|
var myBusComp; var pickBusComp; pickBusComp = myBusComp.GetPicklistBusComp(FieldName);
|
|
Returns the current search expression.
|
var myBusComp; var sExpr; sExpr = myBusComp.GetSearchExpr()
|
|
Returns the current search specification for the field specified in the argument.
|
var myBusComp; var sSpec; sSpec = myBusComp.GetSearchSpec(FieldName);
|
|
Returns the value for a property name specified in the argument.
|
var myBusComp; var sValue; sValue = myBusComp.GetUserProperty(propertyName);
|
|
Returns the visibility mode for the business component.
|
var myBusComp; var iMode; iMode = myBusComp.GetViewMode();
|
|
Calls the specialized method named in the argument.
|
var myBusComp; var sReturn; sReturn = myBusComp.InvokeMethod(methodName, methodArg1, methodArg2,..., methodArgn);
|
|
Moves to the last record in the business component.
|
var myBusComp; var iReturn; iReturn = myBusComp.LastRecord();
|
|
Returns the name of the business component.
|
var myBusComp; var sName; sName = myBusComp.Name();
|
|
Adds a new record to the business component.
|
var myBusComp; myBusComp.NewRecord(whereIndicator);
|
|
Moves to the next record in the business component.
|
var myBusComp; var bFound; bFound = myBusComp.NextRecord();
|
|
Moves to the next record of the current multiple selection.
|
var myBusComp; var iReturn; iReturn = myBusComp.NextSelected();
|
|
Returns the parent business component.
|
var myBusComp; var parentBusComp; parentBusComp = myBusComp.ParentBusComp();
|
|
Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.
|
var myBusComp; myBusComp.Pick();
|
|
Moves to the previous record in the business component.
|
var myBusComp; var iReturn; iReturn = myBusComp.PreviousRecord();
|
|
Refines a query after a query has been executed.
|
var myBusComp; myBusComp.RefineQuery();
|
|
Assigns a new value to the named field for the current row of the business component.
|
var myBusComp; myBusComp.SetFieldValue(FieldName, FieldValue);
|
|
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.
|
var myBusComp; myBusComp.SetFormattedFieldValue(FieldName, FieldValue);
|
|
Assigns a new value to the fields specified in the property set for the current row of the business component.
|
var myBusComp; myBusComp.SetMultipleFieldValues(oPropSet)
|
|
Sets a named search specification on the business component.
|
var myBusComp; myBusComp.SetNamedSearch(searchName, searchSpec);
|
|
Sets the search specification for the business component.
|
var myBusComp; myBusComp.SetSearchExpr(searchSpec);
|
|
Sets the search specification for the specified field.
|
var myBusComp; myBusComp.SetSearchSpec(FieldName, searchSpec);
|
|
Sets the sort specification for a query.
|
var myBusComp; myBusComp.SetSortSpec(sortSpec);
|
|
Sets the value of the specified User Property.
|
var myBusComp; myBusComp.SetUserProperty(propertyName, newValue);
|
|
Sets the visibility type for the business component.
|
var myBusComp; myBusComp.SetViewMode(viewMode);
|
|
Deletes an active record created by NewRecord.
|
var myBusComp; myBusComp.UndoRecord();
|
|
Commits to the database any changes made to the current record.
|
var myBusComp; myBusComp.WriteRecord();
|