Siebel Object Interfaces Reference > Siebel Object Interfaces Reference > Object Interfaces Reference >

Business Object Methods

This topic describes business object methods. It includes the following topics:

• GetBusComp Method for a Business Object
• GetLastErrCode Method for a Business Object
• GetLastErrText Method for a Business Object
• Name Method for a Business Object
• Release Method for a Business Object

In this topic, the term oBusObj indicates a variable that contains a BusObject.

GetBusComp Method for a Business Object

The GetBusComp method returns the name of a business component instance. If an instance of the business component that the BusCompName argument specifies:

• Exists, then the GetBusComp method returns the name of that instance.
• Does not exist, then the interpreter starts a new business component instance, and then the GetBusComp method returns the name of this instance.

Format

oBusObj.GetBusComp (BusCompName)

Table 82 describes the arguments for the GetBusComp method.

The BusCompName argument is case-sensitive. It must match the case of the name that Siebel Tools displays in the Name property of the business component.

Usage

If a business component instance exists but you must create a new instance, then you can do the following:

1. Use the GetBusObject method to create a new business object instance.
2. For this new business instance, use the GetBusComp method to create a new business component.

   These steps create a new business component instance that is different from the business component instance that already exists.

If you use a business object instance that already exists, then your configuration includes any other business components that reference that business object instance, even if you use the GetBusComp method.

If you no longer require the business component instance, then use one of the following keywords:

• In Siebel VB, use Nothing ().
• In Siebel eScript or Browser Script, use null ().

In Browser Script, the GetBusComp method can only access business component instances in the current view. In Server Script, the GetBusComp method can access every business component instance that exists in the active business object.

Used With

Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Server Script

Examples

The following examples are in Siebel eScript:

• To access a business component in a UI context:

  var ActiveBO = TheApplication().ActiveBusObject();
  var ConBC = ActiveBO.GetBusComp("Contact");

• To access a business component in a nonUI context:

  var BO = TheApplication().GetBusObject("Account");
  var ConBC = BO.GetBusComp("Contact");

GetLastErrCode Method for a Business Object

The GetLastErrCode method returns the error code for the error that Siebel CRM logged most recently. This code is a short integer. 0 (zero) indicates no error.

Format

oBusObj.GetLastErrCode

No arguments are available.

Usage

For more information, see Usage for the GetLastErrCode Method.

Used With

COM Data Control, Mobile Web Client Automation Server

GetLastErrText Method for a Business Object

The GetLastErrText method returns a string that contains the text message for the error that Siebel CRM logged most recently.

Format

oBusObj.GetLastErrText

No arguments are available.

Usage

For more information, see Usage for the GetLastErrText Method.

Used With

COM Data Control, Mobile Web Client Automation Server

Name Method for a Business Object

The Name method returns a string that contains the name of a business object.

Format

oBusObj.Name

No arguments are available.

Used With

Browser Script, COM Data Control, COM Data Server, Siebel Java Data Bean, Mobile Web Client Automation Server, Server Script

Examples

For an example, see Name Method for a Business Component.

Release Method for a Business Object

The Release method for a business object releases a business object and the resources for this business object on the Siebel Server. This method does not return any information.

Format

oBusObj.release()

No arguments are available.

Used With

Siebel Java Data Bean

Examples

The following example is for Siebel Java Data Bean:

import com.siebel.data.*;

{
...

// create Siebel Java Data Bean
SiebelDataBean Sieb_dataBean = null;
Sieb_dataBean = new SiebelDataBean();


// log in to Siebel Java Data Bean

...

// Create Siebel Bus Object.
// get the Bus Object from SiebelDataBean
SiebelBusObject busObj = null;
busObj = Sieb_dataBean.getBusObject("Account");


...

// Use the business Object
// Release the business object resources

...

busObj.release();
}