Siebel Object Interfaces Reference > Interfaces Reference > Business Component Methods >

DeactivateFields Method

DeactivateFields deactivates the fields that are currently active from a business component SQL query statement, except those that are not ForceActive, required for a link, or required by the BusComp class.

Syntax

BusComp.DeactivateFields

Returns

Not applicable

Usage

You must activate fields using ActivateField prior to executing a query for the business component.

By default, fields are inactive except when:

• They are displayed on the applet and the business component is the instance on which the applet is based.
• They are System fields (which include Id, Created, Created By, Updated, and Updated By).
• Their Force Active property is set to TRUE.
• The ActivateField method has been invoked on them and an ExecuteQuery method has been executed afterwards.
• They have the Link Specification property set to TRUE.

After fields have been deactivated, the business component must be reexecuted or the application fails.

Used With

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

Examples

The following example is for COM. SiebelApplication is an Application instance.

Dim oBO As BusObject
Dim OBC As BusComp
Dim errCode

Set oBO = SiebelApplication.GetBusObject("Account", errCode)
Set oBC = oBO.GetBusComp("Account", errCode)
oBC.DeactivateFields errCode
oBC.ActivateField "Name", errCode
oBC.ActivateField "Location", errCode
oBC.ClearToQuery errCode
oBC.ExecuteQuery ForwardOnly, errCode
Set oBC = Nothing
Set oBO = Nothing

The following example is in Siebel eScript:

var oBC;
var oBO;

oBO = TheApplication().GetBusObject("Account");
oBC = oBO.GetBusComp("Account");
oBC.DeactivateFields();
oBC.ActivateField("Name");
oBC.ActivateField("Location");
oBC.ClearToQuery();
oBC.ExecuteQuery(ForwardOnly);
oBC = null;
oBO = null;

The following example is in Siebel VB:

Dim oBO As BusObject
Dim oBC As BusComp

Set oBO = TheApplication.GetBusObject("Account")
Set oBC = oBO.GetBusComp("Account")
oBC.DeactivateFields
oBC.ActivateField "Name"
oBC.ActivateField "Location"
oBC.ClearToQuery
oBC.ExecuteQuery ForwardOnly
Set oBC = Nothing
Set oBO = Nothing

Related Topic

ActivateField Method