1. Developer’s Reference
  2. What’s New in This Release

3Applet Classes

Overview of Applet Classes

An applet class is an object type that Siebel CRM uses to create an instance of a frame object. For important caution information, see Using Specialized Classes.

    Using SWE Classes Starting with Siebel CRM Version7.x

    Starting with Siebel CRM version 7.x, the Siebel Web Engine converts all classes that include a CSSFrame prefix in the class name to a counterpart class that includes a CSSSWEFrame prefix. For example, Siebel CRM converts a call that calls a method in the CSSFrameBase class to a call that calls the corresponding method in the CSSSWEFrameBase class. It does this conversion at run time.

    The descriptions in this chapter use the SWE name for the class. These descriptions also apply to the corresponding class that does not use SWE. For example, the description for the CSSSWEFrame class also applies to the CSSFrame class.

      CSSSWEFrame Class

      The CSSSWEFrame class represents an applet that resides in the Siebel UI Frameworks. You can use this class to call a generalized applet method.

      The CSSSWEBase class is the parent of this class.

      The Specifying the Method That the Enter Key Calls applet user property can reference the CSSSWEFrame class.

      The CSSSWEFrame class requires the CSSSWEFrameMgr class and the business component objects that use the CSSSWEFrameMgr class.

      The CSSSWEFrame class can reference the following methods:

      • ExecuteQuery. Runs the query. You can configure Siebel CRM to call this method from any item described in Calling a Method except from an external interface.

      • NewQuery. Modifies the mode to query mode and starts a new query.

      • Other methods. Any method that Siebel CRM gets from a CSSSWEBase method.

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

      CSSSWEFrameBase Class

      The CSSSWEFrameBase class provides functionality through applet user properties and call methods, such as Aspect user properties and the GotoView method.

      The FrameListBase classes provide the same support as their FrameBase counterparts. The following descriptions also apply to the CSSFrameListBase class and the CSSSWEFrameListBase class.

      Siebel CRM uses the CSSSWEFrameBase class for basic frame support. It uses applet user properties and methods that are common to many Siebel Business Applications.

      The CSSSWEFrame class is the parent of this class.

      The following topics describe applet user properties that can reference the CSSSWEFrameBase class:

      The CSSSWEFrameBase class can reference the following methods:

      • GotoPage. Displays a Web page. The Page user property must specify the Web page. For more information, see Specifying the Goto Web Page.

      • GotoUrl. Displays a URL. The Url user property must specify the URL. For more information, see Specifying the Goto URL.

      • GotoView. Displays a view. The View user property must specify the view. For more information, see Specifying the Goto View.

      You can specify each method in the Method property of a class method. This class method is a child of the CSSSWEFrameBase class. You can configure Siebel CRM to call each of these methods only through a named method.

      CSSSWEFrameList Class

      The CSSSWEFrameList class:

      • Represents a list applet in the Siebel UI Frameworks. You can use it to call a method that is specific to an applet.

      • Requires a list object.

      • Can reference any method that Siebel CRM gets from the methods described in CSSSWEFrame Class.

      The CSSSWEFrame class is the parent of the CSSSWEFrameList class.

      CSSSWEFrameListBase Class

      Siebel CRM uses the CSSSWEFrameListBase class for basic frame support in a list applet. These classes provides the same support as their FrameBase counterparts. For more information about these classes, see CSSSWEFrameBase Class.

      CSSSWEFrameListFile Class

      Siebel CRM uses the CSSSWEFrameListFile class for file attachment frames in Siebel UI Frameworks. You can use it to call file attachment methods.

      The CSSSWEFrameList class is the parent of the CSSSWEFrameListFile class.

      The business component that provides data to the file attachment frame must reference the CSSBCFile class.

      CSSSWEFrameListDocGen Class

      The CSSSWEFrameListDocGen class supports proposal and presentation features. It does the following work:

      • Sets the document context. For example, opportunity proposal, account proposal, and so on.

      • Sets the context. For example, Microsoft Word or Microsoft PowerPoint.

      • To create proposals, it submits requests to the Document Server server component.

      The following classes are specialized subclasses of the CSSSWEFrameListDocGen class:

      • CSSFrameListProposal and CSSSWEFrameListProposal. Sets the type of document as a proposal. Supports proposal applets that create Microsoft Word documents.

      • CSSFrameListPresentation and CSSSWEFrameListPresentation. Sets the type of document as a presentation. Supports presentation applets that create Microsoft PowerPoint documents.

      These subclasses get all other functionality from the CSSSWEFrameListDocGen class. For important caution information, see Using Specialized Classes.

      The CSSSWEFrameList class is the parent of this class.

      The following topics describe applet user properties that can reference the CSSSWEFrameListDocGen class:

      CSSSWEFrameListWeb Class

      The CSSSWEFrameListWeb class is a specialized frame class that Siebel CRM uses for ERM (Employee Relationship Management), ePortal, and eBriefing applications. The Compensation Planning and Group New modules in ERM use this class. It supports hiding an applet with no data, field visibility control, and other support for ERM applications.

      You can use this class only in a Siebel application that uses ERM. If you must use a modified version of the CSSSWEFrameListWeb class, then you must create a new class that references the CSSSWEFrameListWeb class. You must not make modifications directly to the CSSSWEFrameListWeb class.

      The CSSSWEFrameList class is the parent of the CSSSWEFrameListWeb class.

      The applet user property described in Hiding Applets That Contain No Data can reference the CSSSWEFrameListWeb class.

      For important caution information, see Using Specialized Classes.

      CSSSWEFrameSalutation Class

      The CSSSWEFrameSalutation class supports the salutation frame. You can use it to display a salutation, typically in the home page. It contains a control named Explorer that it uses to display data. The frame removes the field values from the Result Text column and displays them together when it displays the Explorer control.

      The CSSSWEFrame class is the parent of the CSSSWEFrameSalutation class.

      The CSSSWEFrameSalutation class can reference any method that Siebel CRM gets from the methods described in CSSSWEFrame Class.

      CSSSWEFrameContactOrgChart Class

      CSSSWEFrameContactOrgChart supports the Contact Organization Chart frame and applet.

      The CSSSWEFrame class is the parent of the CSSSWEFrameContactOrgChart class.

      The following topics describe applet user properties that can reference the CSSSWEFrameContactOrgChart class:

      CSSSWEFrameListFINApplication Class

      The CSSSWEFrameListFINApplication class provides specialized support in applets that Siebel CRM uses for personal or business transactions, such as applying for credit or opening an account.

      You can use this class only with an applet that references the Opportunity business component. This class sets the Application Flag field to TRUE.

      The CSSSWEFrameListBase class is the parent of this class.

      The applet user property described in Disabling Methods for FINS Applets in Query Mode can reference the CSSSWEFrameListFINApplication class.

      For important caution information, see Using Specialized Classes.

      CSSSWEFrameUserRegistration Class

      The CSSSWEFrameUserRegistration class supports required fields in applets in the User Registration module. In some situations, it might be necessary to get information from a user that a business component record does not require. You can use this class to enforce this kind of requirement.

      The CSSSWEFrame class is the parent of the CSSSWEFrameUserRegistration class.

      The applet user property described in Disallowing Users to Pick Dates in the Forecast Date Dialog Box can reference the CSSSWEFrameUserRegistration class.

      You can use the CSSSWEFrameUserRegistration class only with the User Registration module. This class assumes that the business component that provides data in this situation references the CSSBCUser class. For example, the User Registration business component.

      If your configuration uses the Show Required user property, then the corresponding business component must reference the CSSBCUser class. The control that this user property specifies must reside in the applet. If it does not, then the user cannot enter a value for the required control.