Siebel Object Interfaces Reference > Java Data Bean Quick Reference >

Business Component Methods for Java Data Bean


Table 52 lists a summary of the SiebelBusComp methods' syntax.

Table 52 does not include methods that are not invoked directly from a Business Component object instance. For information on methods that are called with InvokeMethod on the Business Component object, see InvokeMethod Methods for the Business Component Object.

Table 52. SiebelBusComp Methods Syntax Summary
Method
Description
Syntax

ActivateField Method

Allows queries to retrieve data for the specified field.

boolean activateField(String fieldName) throws SiebelException

ActivateMultipleFields Method

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

boolean activateMultipleFields(SiebelPropertySet psFields) throws SiebelException

Associate Method

Creates a new many-to-many relationship for the parent object through an association business component.

boolean associate(boolean isInsertBefore) throws SiebelException

BusObject Method

Returns the business object that contains the business component.

SiebelBusObject busObject() throws SiebelException

ClearToQuery Method

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

boolean clearToQuery() throws SiebelException

DeactivateFields Method

Deactivates every currently activated field.

boolean deactivateFields()

DeleteRecord Method

Removes the current record from the business component.

boolean deleteRecord() throws SiebelException

ExecuteQuery Method

Retrieves a set of BusComp records.

boolean executeQuery(boolean cursorMode) throws SiebelException

NOTE:  When using the ExecuteQuery method with Java Data Bean, use True for ForwardOnly and False for ForwardBackward.

ExecuteQuery2 Method

Retrieves a set of BusComp records.

boolean executeQuery2(boolean cursorMode, boolean ignoreMaxCursorSize) throws SiebelException

FirstRecord Method

Moves to the first record in the business component.

boolean firstRecord() throws SiebelException

GetFieldValue Method

Returns a value for the field specified in the argument.

String getFieldValue(String fieldName) throws SiebelException

GetFormattedFieldValue Method

Returns a formatted value for the field specified in the argument.

String getFormattedFieldValue(String fieldName) throws SiebelException

GetMultipleFieldValues Method

Returns values for the fields specified in the property set.

boolean getMultipleFieldValues(SiebelPropertySet Src, SiebelPropertySet result) throws SiebelException

GetMVGBusComp Method

Returns the MVG business component associated with the field specified in the argument.

SiebelBusComp getMVGBusComp(String fieldName) throws SiebelException

GetNamedSearch Method

Returns the argument-named search specification.

String getNamedSearch(String searchName) throws SiebelException

GetPicklistBusComp Method

Returns the pick business component associated with the field specified in the argument.

SiebelBusComp getPicklistBusComp(String fieldName) throws SiebelException

GetSearchExpr Method

Returns the current search expression.

String getSearchExpr() throws SiebelException

GetSearchSpec Method

Returns the current search specification for the field specified in the argument.

String getSearchSpec(String fieldName) throws SiebelException

GetUserProperty Method

Returns the value for the specified property.

String getUserProperty(String property) throws SiebelException

GetViewMode Method

Returns the visibility mode for the business component.

int getViewMode()

InvokeMethod Method

Calls the specialized method named in the argument. The methodArgs parameter must be an array of strings.

String invokeMethod(String methodName, String[] methodArgs) throws SiebelException

LastRecord Method

Moves to the last record in the business component.

boolean lastRecord() throws SiebelException

Name Method

Returns the name of the business component.

String name()

NewRecord Method

Adds a new record to the business component.

boolean newRecord(boolean isInsertBefore) throws SiebelException

NextRecord Method

Moves to the next record in the business component.

boolean nextRecord() throws SiebelException

ParentBusComp Method

Returns the parent business component.

SiebelBusComp parentBusComp() throws SiebelException

Pick Method

Places the currently selected record in a picklist business component into the appropriate fields of the parent business component.

boolean pick() throws SiebelException

PreviousRecord Method

Moves to the previous record in the business component.

boolean previousRecord() throws SiebelException

RefineQuery Method

Refines a query after a query has been executed.

boolean refineQuery() throws SiebelException

Release Method

Enables the release of the business component and its resources on the Siebel Server.

void release()

SetFieldValue Method

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

boolean setFieldValue(String fieldName, String fieldValue) throws SiebelException

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.

boolean setFormattedFieldValue(String fieldName, String fieldValue) throws SiebelException

SetMultipleFieldValues Method

Assigns new values to the multiple fields specified in the property set for the current row of the business component.

boolean setMultipleFieldValues(SiebelPropertySet psFields) throws SiebelException

SetNamedSearch Method

Sets a named search specification on the business component.

boolean setNamedSearch(String searchName, String searchText) throws SiebelException

SetSearchExpr Method

Sets an entire search expression on the business component.

boolean setSearchExpr(String searchExpr) throws SiebelException

SetSearchSpec Method

Sets the search specification for the specified field.

boolean setSearchSpec(String fieldName, String searchSpec) throws SiebelException

SetSortSpec Method

Sets the sort specification for a query.

boolean setSortSpec(String sortSpec) throws SiebelException

SetUserProperty Method

Sets the value of the specified User Property.

boolean setUserProperty(String propName, String propVal)

SetViewMode Method

Sets the visibility type for the business component.

boolean setViewMode(int mode) throws SiebelException

UndoRecord Method

Reverses any uncommitted changes made to the record.

boolean undoRecord() throws SiebelException

WriteRecord Method

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

boolean writeRecord() throws SiebelException

Siebel Object Interfaces Reference Copyright © 2008, Oracle. All rights reserved.