13Siebel Java Data Bean Quick Reference

Siebel Java Data Bean Quick Reference

This chapter describes summary information for the Siebel Java Data Bean. It includes the following topics:

• Data Bean Methods for Siebel Java Data Bean

• Business Component Methods for Siebel Java Data Bean

• Business Object Methods for Siebel Java Data Bean

• Business Service Methods for Siebel Java Data Bean

• Property Set Methods for Siebel Java Data Bean

• Siebel Exception Methods for Siebel Java Data Bean

For more information about Siebel Java Data Bean, see the Javadoc files that reside in the Siebel_JavaDoc.jar file. This file is typically located in the \siebsrvr\CLASSES folder.

Data Bean Methods for Siebel Java Data Bean

The following table describes a summary of Data Bean methods you can use with Siebel Java Data Bean.

Table Summary of Data Bean Methods for Siebel Java Data Bean

Method	Description	Format
Attach Method for an Application	Allows an external application to reconnect to an existing Siebel session.	boolean attach(String sessionID) throws SiebelException
CurrencyCode Method for an Application	Returns the currency code that is associated with the division of the user position.	String currencyCode()
Detach Method for an Application	Returns a string that contains the Siebel session ID.	String detach() throws SiebelException
GetBusObject Method for an Application	Creates a new instance of a business object.	SiebelBusObject getBusObject(String boName) throws SiebelException
GetProfileAttr Method for an Application	Returns the name of an attribute in a user profile.	String getProfileAttr(String attrName) throws SiebelException
GetService Method for an Application	Locates a business service. If this business service is not already running, then Siebel CRM starts it.	SiebelService getService(string serviceName) throws SiebelException
InvokeMethod Method for an Application	Calls a method.	String invokeMethod(String name, String[] args) throws SiebelException
Login Method for an Application	Allows an external application to log in to the COM Data Server, COM Data Control, or Siebel Java Data Bean, and to access Siebel objects.	boolean login(String connString, String userName, String passWord) throws SiebelException
LoginId Method for an Application	Returns the login ID of the user who started the Siebel application.	String loginId()
LoginName Method for an Application	Returns the login name of the user who started the Siebel application.	String loginName()
Logoff Method for an Application	Disconnects the Siebel client from the Siebel Server.	boolean logoff() throws SiebelException
NewPropertySet Method for an Application	Creates a new property set.	SiebelPropertySet newPropertySet()
PositionId Method for an Application	Returns the position ID of the user position.	String positionId()
PositionName Method for an Application	Returns the name of the current user position.	String positionName()
SetPositionId Method for an Application	Sets the active position to a Position ID.	boolean setPositionId(String posId) throws SiebelException
SetPositionName Method for an Application	Sets the active position to a position name.	boolean setPositionName(String posName) throws SiebelException
SetProfileAttr Method for an Application	Personalization uses this method to set a value for an attribute in a user profile.	boolean setProfileAttr(String attrName,String attrValue) throws SiebelException
Trace Method for an Application	Appends a message to the trace file.	boolean trace(String message) throws SiebelException
TraceOff Method for an Application	Turns off tracing.	boolean traceOff() throws SiebelException
TraceOn Method for an Application	Turns on tracing.	boolean traceOn(String filename, String Category, String selection)throws SiebelException

Business Component Methods for Siebel Java Data Bean

The following table 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 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

Business Object Methods for Siebel Java Data Bean

The following table describes a summary of business object methods you can use with Siebel Java Data Bean.

Table Summary of Business Object Methods for Siebel Java Data Bean

Method	Description	Format
GetBusComp Method for a Business Object	Returns the name of a business component.	SiebelBusComp getBusComp(String busCompName) throws SiebelException
Name Method for a Business Object	Returns the name of the business object.	String name()
Release Method for a Business Object	Releases a business object and the resources for this business object on the Siebel Server.	void release()

Business Service Methods for Siebel Java Data Bean

The following table describes a summary of business service methods you can use with Siebel Java Data Bean.

Table Summary of Business Service Methods for Siebel Java Data Bean

Method	Description	Format
Business Service Methods	Returns the name of the first property of a business service.	String getFirstProperty()
GetNextProperty Method for a Business Service	Returns the name of the next property of a business service.	String getNextProperty()
GetProperty Method for a Business Service	Returns the value of a property.	String getProperty(String propName) throws SiebelException
InvokeMethod Method for a Business Service	Calls a method.	boolean invokeMethod(String methodName, SiebelPropertySet inputPropertySet, SiebelPropertySet outputPropertySet) throws SiebelException
Name Method for a Business Service	Returns the name of a business service.	String Name()
PropertyExists Method for a Business Service	Returns a Boolean value that indicates if the property that the argument identifies exists.	boolean propertyExists(String propName) throws SiebelException
Release Method for a Business Service	Releases a business service and the resources that this business service uses on the Siebel Server.	void release()
RemoveProperty Method for a Business Service	Removes a property from a business service.	void removeProperty(String propName) throws SiebelException
SetProperty Method for a Business Service	Sets a value for a property of a business service.	void setProperty(String propName, String propValue) throws SiebelException

Property Set Methods for Siebel Java Data Bean

Property Set Methods for Siebel Java Data Bean describes a summary of property set methods you can use with Siebel Java Data Bean.

Table Summary of Property Set Methods for Siebel Java Data Bean

Method	Description	Format
AddChild Method for a Property Set	Adds child property sets to a property set.	int addChild(SiebelPropertySet propertySet)
Copy Method for a Property Set	Returns a copy of a property set.	SiebelPropertySet copy(SiebelPropertySet propertySet)
GetByteValue Method for a Property Set	Returns a byte array if a byte value is set.	public byte[] getByteValue()
GetChild Method for a Property Set	Returns a child property set of a property set.	SiebelPropertySet getChild(int index)
GetChildCount Method for a Property Set	Returns the number of child property sets that exist for a parent property set.	int getChildCount()
GetFirstProperty Method for a Property Set	Returns the name of the first property in a property set.	String getFirstProperty()
GetNextProperty Method for a Property Set	Returns the name of the next property in a property set.	String getNextProperty()
GetProperty Method for a Property Set	Returns the value of a property.	String getProperty(String propertyName)
GetPropertyCount Method for a Property Set	Returns the number of properties that exist in the current level in the hierarchy.	int GetPropertyCount()
GetType Method for a Property Set	Returns the value of the type attribute of a property set.	String getType()
GetValue Method for a Property Set	Returns the value of the value attribute of a property set.	String getValue()
InsertChildAt Method for a Property Set	Inserts a child property set in a parent property set at a specific location.	boolean insertChildAt(SiebelPropertySet propertySet, int index)
PropertyExists Method for a Property Set	Returns a Boolean value that indicates if the property that the argument identifies exists.	boolean propertyExists(String propertyName)
RemoveChild Method for a Property Set	Removes a child property set from a parent property set.	boolean removeChild(int index)
RemoveProperty Method for a Property Set	Removes a property from a property set.	boolean removeProperty(String propertyName)
Reset Method for a Property Set	Removes every property and child property set from a property set.	boolean reset()
SetByteValue Method for a Property Set	Sets the value portion of a property set.	public void setByteValue(byte[] value)
SetProperty Method for a Property Set	Sets a value in the property of a property set.	boolean setProperty(String propertyName, String propertyValue)
SetType Method for a Property Set	Sets the value for the type attribute of a property set.	boolean setType(String type)
SetValue Method for a Property Set	Sets the value for the value attribute of a property set.	boolean setValue(String value)

Siebel Exception Methods for Siebel Java Data Bean

The following table describes a summary of Siebel exception methods that you can use with Siebel Java Data Bean. The Siebel Java Data Bean is one of Oracle’s Siebel Object Interfaces.

Table Summary of Siebel Exception Methods for Siebel Java Data Bean

Method	Description	Format
GetErrorCode Method	Returns a numeric error code.	int getErrorCode()
GetErrorMessage Method	Returns an error message.	String getErrorMessage()