EnterpriseItem bean

This managed bean is the source for a single BusinessObjects Enterprise object such as a report, folder, or program. This bean provides information and adds functionality to the UI components.

To learn more about core BusinessObjects Enterprise functionality and application development, consult the BusinessObjects Enterprise Java SDK Guide.

Click the appropriate link to go to that section:

• Overview
• Example faces-config.xml declaration

Overview

The EnterpriseItem bean is the source for a BusinessObjects Enterprise object, and is used to represent an object on the page. An EnterpriseItem bean is a key aspect of any application built with JavaServer Faces Components for BusinessObjects Enterprise. Many components, such as ReportPageViewer component, depend on the EnterpriseItem bean because their function is to operate on a BusinessObjects Enterprise object. For example, the purpose of the ReportPageViewer component is to view, specifically, a report object. To retrieve a BusinessObjects Enterprise object from the system, the object must be queried for by the page using the BusinessObjects Enterprise query language. The EnterpriseItem bean, however, reduces this complexity down to a set of properties that generate a query string automatically. Set the properties to desired values to retrieve the object of interest. For more information on the BusinessObjects Enterprise query language, see the BusinessObjects Enterprise Java SDK Guide.

The itemID property is central to making the relationship between the EnterpriseItem bean and the actual object, as it specifies the ID or CUID of the object represented by the EnterpriseItem bean. For example, you may set this property to the report ID of a report the user selected in one of your pages. This EnterpriseItem bean could then be bound to a ReportPageViewer component to render and display that report to the user. The itemID property can be set many different ways. A common scenario would be to set the itemID property programmatically after the user selects a single item from a list of items in the page. In this case, you would have actually queried for a collection of items represented by an EnterpriseItems bean, displayed the collection of items represented by the EnterpriseItems bean using a component such as the ItemsGrid component, and then passed in the single ID of the item selected by the user into an EnterpriseItem bean. For more information, see EnterpriseItems bean. How you set the itemID property for an EnterpriseItem bean in the page depends heavily on the scenario you are trying to implement.

The fields property defines the database fields you want to query for, which determines which object properties and property bags are retrieved with the object. Select which fields are returned with the object so that the EnterpriseItem bean has access to the information you require. Examples of valid strings include:

• All

Return all fields.

• SI_ID

A number that uniquely identifies an object in the BusinessObjects Enterprise system.

• SI_CUID

Cluster Unique Identifier. Identifies an object and is guaranteed to be unique within a cluster.

• SI_NAME

The textual name of the object.

• SI_DESCRIPTION

The textual description of the object.

• SI_GUID

Globally Unique Identifier. Identifies an object and is guaranteed to be unique.

• SI_PARENTID

A number that uniquely identifies an object’s parent.

• SI_PARENTCUID

The Cluster Unique Identifier for an object’s parent. Guaranteed to be unique within a cluster.

• SI_INSTANCE

A Boolean value that indicates whether the object is a report instance.

• SI_PROGID

A string specifying the name of the component that implements the object. Examples of valid ProgID values include CrystalEnterprise.Folder, CrystalEnterprise.Report, and CrystalEnterprise.PDF. Consult the BusinessObjects Enterprise Java SDK Guide for a complete list.

• SI_OWNER

The textual name of the user who owns a particular object.

• SI_OWNERID

A number that uniquely identifies the user who owns a particular object.

• SI_CREATION_TIME

The date and time of when the object was created.

• SI_LAST_RUN_TIME

The date and time of when the object was last run.

• SI_UPDATE_TS

The date and time of when the object was last modified.

• SI_PROCESSINGINFO

Contains properties that specify the processing information of an object.

• SI_SCHEDULEINFO

Contains properties that specify the current status and information of the scheduled job.

• SI_HASTHUMBNAIL

A Boolean value that indicates whether the object has an accompanying thumbnail image.

Your EnterpriseItem bean will be able to access and manipulate the object’s fields based on the selections you make for this fields property. So, for example, "All" would return all fields, whereas {"SI_NAME, SI_DESCRIPTION, SI_PROGID"} would return only three specific fields, including the title, description, and ProgID of the item.

Note:    For more information on BusinessObjects Enterprise ProgIDs, see the BusinessObjects Enterprise Java SDK Guide.

Note:    For a comprehensive reference of all EnterpriseItem bean members, see the IEnterpriseItem interface in the JavaServer Faces Components for BusinessObjects Enterprise Java API Reference.

Example faces-config.xml declaration

<managed-bean>

    <description>Source for a single report.</description>

    <managed-bean-name>report</managed-bean-name>

    <managed-bean-class>

        com.businessobjects.jsf.appcontrols.model.EnterpriseItem

    </managed-bean-class>

    <managed-bean-scope>session</managed-bean-scope>

    <managed-property>

        <property-name>itemID</property-name>

        <value>0</value>

    </managed-property>

</managed-bean>