Siebel Object Interfaces Reference > Siebel Java Data Bean Quick Reference > Object Interfaces Reference >

Business Component Methods for Siebel Java Data Bean


Table 156 describes a summary of business component methods you can use with Siebel Java Data Bean. It does not include object interface methods that Siebel CRM does not call directly from a business component instance. For information about methods that Siebel CRM calls with the InvokeMethod method on a business component, see Business Component Invoke Methods.

Table 156. Summary of Business Component Methods for Siebel Java Data Bean
Method
Description
Format

ActivateField Method for a Business Component

Activates a field.

boolean activateField(String fieldName) throws SiebelException

ActivateMultipleFields Method for a Business Component

Activates multiple fields.

boolean activateMultipleFields(SiebelPropertySet psFields) throws SiebelException

Associate Method for a Business Component

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

boolean associate(boolean isInsertBefore) throws SiebelException

BusObject Method for a Business Component

Returns the name of the business object that the business component references.

SiebelBusObject busObject() throws SiebelException

ClearToQuery Method for a Business Component

Clears the current query but does not clear sort specifications on a business component.

boolean clearToQuery() throws SiebelException

DeactivateFields Method for a Business Component

Deactivates the fields that are currently active from the SQL query statement of a business component.

boolean deactivateFields()

DeleteRecord Method for a Business Component

Removes the current record from a business component.

boolean deleteRecord() throws SiebelException

ExecuteQuery Method for a Business Component

Returns a set of business component records.

boolean executeQuery(boolean cursorMode) throws SiebelException

If using the ExecuteQuery method with Siebel Java Data Bean, use True for ForwardOnly and False for ForwardBackward.

ExecuteQuery2 Method for a Business Component

Returns a set of business component records. Allows you to control the number of records Siebel CRM returns.

boolean executeQuery2(boolean cursorMode, boolean ignoreMaxCursorSize) throws SiebelException

FirstRecord Method for a Business Component

Moves the record pointer to the first record in a business component, making that record the current record.

boolean firstRecord() throws SiebelException

GetFieldValue Method for a Business Component

Returns the value of a field from the current record of a business component.

String getFieldValue(String fieldName) throws SiebelException

GetFormattedFieldValue Method for a Business Component

Returns a field value that is in the same format that the Siebel client uses.

String getFormattedFieldValue(String fieldName) throws SiebelException

GetMultipleFieldValues Method for a Business Component

Returns values for the fields specified in a property set.

boolean getMultipleFieldValues(SiebelPropertySet Src, SiebelPropertySet result) throws SiebelException

GetMVGBusComp Method for a Business Component

Returns the multivalue group business component that is associated a business component field.

SiebelBusComp getMVGBusComp(String fieldName) throws SiebelException

GetNamedSearch Method for a Business Component

Returns the name of a search specification.

String getNamedSearch(String searchName) throws SiebelException

GetPicklistBusComp Method for a Business Component

Returns the name of the pick business component that is associated with a field in the current business component.

SiebelBusComp getPicklistBusComp(String fieldName) throws SiebelException

GetSearchExpr Method for a Business Component

Returns the current search expression that is defined for a business component.

String getSearchExpr() throws SiebelException

GetSearchSpec Method for a Business Component

Returns the search specification that is defined for a business component.

String getSearchSpec(String fieldName) throws SiebelException

GetUserProperty Method for a Business Component

Returns the value for the specified property.

String getUserProperty(String property) throws SiebelException

GetViewMode Method for a Business Component

Returns the visibility mode for a business component.

int getViewMode()

InvokeMethod Method for a Business Component

Calls a method.

String invokeMethod(String methodName, String[] methArg1, methArg2, methArgN) throws SiebelException

LastRecord Method for a Business Component

Moves the record pointer to the last record in a business component.

boolean lastRecord() throws SiebelException

Name Method for a Business Component

Returns the name of a business component.

String name()

NewRecord Method for a Business Component

Adds a new record to a business component.

boolean newRecord(boolean isInsertBefore) throws SiebelException

NextRecord Method for a Business Component

Moves the record pointer to the next record in a business component, making that record the current record.

boolean nextRecord() throws SiebelException

ParentBusComp Method for a Business Component

Returns the name of a parent business component.

SiebelBusComp parentBusComp() throws SiebelException

Pick Method for a Business Component

Places the currently chosen record in a pick business component into the appropriate fields of the parent business component.

boolean pick() throws SiebelException

PreviousRecord Method for a Business Component

Moves the record pointer to the previous record in a business component, making that record the current record.

boolean previousRecord() throws SiebelException

RefineQuery Method for a Business Component

Refines a query.

boolean refineQuery() throws SiebelException

Release Method for a Business Component

Releases a business component and the resources for this business component that exist on the Siebel Server.

void release()

SetFieldValue Method for a Business Component

Sets a new value in a field for the current record of a business component.

boolean setFieldValue(String fieldName, String fieldValue) throws SiebelException

SetFormattedFieldValue Method for a Business Component

Sets a new value in a field in the current record of a business component. It accepts the field value in the current local format.

boolean setFormattedFieldValue(String fieldName, String fieldValue) throws SiebelException

SetMultipleFieldValues Method for a Business Component

Sets new values to the multiple fields specified in the property set for the current record of a business component.

boolean setMultipleFieldValues(SiebelPropertySet psFields) throws SiebelException

SetNamedSearch Method for a Business Component

Sets a named search specification on a business component.

boolean setNamedSearch(String searchName, String searchText) throws SiebelException

SetSearchExpr Method for a Business Component

Sets the search expression for a business component.

boolean setSearchExpr(String searchExpr) throws SiebelException

SetSearchSpec Method for a Business Component

Sets the search specification for a business component.

boolean setSearchSpec(String fieldName, String searchSpec) throws SiebelException

SetSortSpec Method for a Business Component

Sets the sort specification for a business component.

boolean setSortSpec(String sortSpec) throws SiebelException

SetUserProperty Method for a Business Component

Sets the value of a user property in a business component.

boolean setUserProperty(String propName, String propVal)

SetViewMode Method for a Business Component

Sets the visibility type for a business component.

boolean setViewMode(int mode) throws SiebelException

UndoRecord Method for a Business Component

Reverses any unsaved modifications made to the record.

boolean undoRecord() throws SiebelException

WriteRecord Method for a Business Component

Saves to the Siebel database any modifications made to the current record.

boolean writeRecord() throws SiebelException

Siebel Object Interfaces Reference Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices.