Siebel Developer's Reference > Business Component Classes > CSSBCBase Class >

Methods That the CSSBCBase Class Can Reference

This topic describes the methods that the CSSBCBase class can reference. It includes the following topics:

• Evaluate Boolean Expression Method
• Evaluate Expression Method
• Is Active Method
• Refresh Business Component Method
• Refresh Record Method
• Revise Method
• Sequence Method
• Set Aspect Method

You can specify each method in the Method property of a class method. This class method is a child of the CSSBCBase class.

Evaluate Boolean Expression Method

The EvalBoolExpr method evaluates a conditional Siebel expression against the current row. It returns one of the following values in the result parameter:

• Y. The expression is true.
• N. The expression is not true.

You can configure Siebel CRM to call the EvalBoolExpr method from each item described in Calling a Method except from a custom button or command.

Table 3 describes the method argument that you can use with the EvalBoolExpr method.

Evaluate Expression Method

The EvalExpr method evaluates a Siebel expression against the current row and returns the value in the result parameter. You can configure Siebel CRM to call the EvalExpr method from each item described in Calling a Method except from a custom button or command.

Is Active Method

The IsActive method reads the Active field value to determine if the row is active. It returns Y or N. You can configure Siebel CRM to call the IsActive method from each item described in Calling a Method except from a custom command.

Refresh Business Component Method

The RefreshBusComp method runs the current query for the business component and places the focus back on the record that Siebel CRM previously highlighted. It refreshes the data but highlights the same record and places the cursor in the same position it occupied in the list applet before Siebel CRM called the RefreshBusComp method. For more information about the IsActive method, see the topic about InvokeMethod methods for business components in Siebel Object Interfaces Reference.

You can configure Siebel CRM to call the IsActive method from each item described in Calling a Method except from a custom command.

Refresh Record Method

The RefreshRecord method refreshes the currently highlighted record. It updates the business component fields in the client and positions the cursor in the context record. For more information about this method, see the topic about InvokeMethod methods for business components object in Siebel Object Interfaces Reference.

You can configure Siebel CRM to call the RefreshRecord method from each item described in Calling a Method except from a custom command.

Revise Method

The Revise method creates a new revision of the current record. Siebel CRM uses it to revise quotes, orders, and agreement records. This method is similar to BusComp_CopyRecord except the Revise method does the following work:

• If the Active Field user property is defined, then it sets the current record to inactive.
• If the Locked Field and Locked By Field user properties are defined, then it locks the current record.
• Increments the revision number of the new record. The Revision Field user property specifies the field that contains the revision number.
• Copies values that exist in fields of the current record to the new record. The Revision Copy Field user property specifies the field that contains the new values.

You can configure Siebel CRM to call the Revise method from each item described in Calling a Method except from a custom command.

For more information, see the following topics:

• Viewing a Business Component User Property
• Creating Numbered Revisions of Quotes, Orders, or Agreements
• Creating Numbered Revisions of Quotes, Orders, or Agreements

Viewing an Example That Uses the Revise Method

This topic describes how to view an example that uses the revise method.

To view an example that uses the Revise method

1. In the client, navigate to the Agreements screen, and then the Agreements List view.
2. Examine the My Agreements list that Siebel CRM displays.

   This list references the Agreement List Applet No Parent applet. The Revise command in the drop-down menu references the Revise method. If you choose a record, and then click Revise, then Siebel CRM does the following:

   • Creates a new record that duplicates the chosen record.
   • Increments the Revision field by 1.

Sequence Method

The Sequence method recreates the sequence numbers for the records in the current business component. It does this only if sequencing is enabled for this business component. Siebel CRM sets the starting value depending on which of the following situations is true:

• A field in a business component includes a sequenced field. For example, the FS Agreement Item business component includes the Line Number field. The Sequence Field user property specifies this Line Number field as the sequence field. The following business component is the corresponding business component:

  FS Agreement Item.Line Number (Sequence)

  The Predefault Value property of the sequence field defines the starting value for the sequence. This value is typically not 1.

• A predefault value is not set for the sequence. Siebel CRM defaults the starting value for the sequence to 1.

You can configure Siebel CRM to call the Sequence method from each item described in Calling a Method.

For more information about creating a sequence field, see Configuring Siebel Business Applications.

For more information, see the following topics:

• Specifying Sequential Line Numbers for New Records
• Specifying Sequential Line Numbers for New Records According to Maximum Values

Set Aspect Method

The SetAspect method sets and overrides the default aspect of the current business component. The applet code or script method calls the SetAspect method to override the business component aspect with the applet aspect. You can configure Siebel CRM to call the SetAspect method only from a server script or a browser script.

Table 4 describes the arguments that you can use with the SetAspect method. For more information, see Using Aspects to Control Read Only, Insert, and Other Behavior.