This managed bean is the source for a collection of BusinessObjects Enterprise objects such as reports, folders, or programs. 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 jump to that section:
The EnterpriseItems
bean is the source of a collection of BusinessObjects Enterprise objects, and is used to represent a collection of objects on the page. Collections are queried from the BusinessObjects Enterprise system by using query strings in the code
enableDefaultParent
and parentItemID
are the two key properties that determine the parent item used when querying for objects. The possible values for the enableDefaultParent
property are fields of the com.businessobjects.jsf.sdk.properties.DefaultParentType
class:
None
The default root object within the BusinessObjects Enterprise system is used as the parent item to query for objects.
CorporateCategory
The main BusinessObjects Enterprise corporate category is used as the parent item to query for objects.
Custom
A custom parent item, specified by the parentItemID
property, is used as the parent item. Set the parentItemID
property to the identifier of the item that will be the parent item for querying for objects.
PersonalCategory
The main BusinessObjects Enterprise personal category is used as the parent item to query for objects.
RootFolder
The root folder within the BusinessObjects Enterprise system is used as the parent item to query for objects.
UserRootCategory
The end user's own root category is used as the parent item.
UserRootFolder
The end user's own root folder is used as the parent item.
The parentItemID
specifies the ID or CUID of the parent of all objects in the collection to be queried. This property can be set in many different ways. For example, you may want to set the parentItemID
property programmatically to the itemID property value of a folder when the user clicks a folder from a list. This ID can then be used to query for a collection of reports within that parent folder.
The fields
property defines the database fields you want to query for. See EnterpriseItem bean for a complete description of this property and its values.
Set the itemTypes
property to one or more kinds of BusinessObjects Enterprise objects you want to query for and return in the collection. Examples of valid strings (ProgIDs) include:
All
CrystalEnterprise.Category
CrystalEnterprise.Analytic
CrystalEnterprise.Excel
CrystalEnterprise.FavoritesFolder
CrystalEnterprise.Folder
CrystalEnterprise.Hyperlink
CrystalEnterprise.MyInfoView
CrystalEnterprise.ObjectPackage
CrystalEnterprise.PersonalCategory
CrystalEnterprise.Pdf
CrystalEnterprise.Program
CrystalEnterprise.Report
CrystalEnterprise.Rtf
CrystalEnterprise.Shortcut
CrystalEnterprise.Txt
CrystalEnterprise.Webi
CrystalEnterprise.Word
So, for example, "All"
would return all fields, whereas {"CrystalEnterprise.Report", "CrystalEnterprise.Pdf", "CrystalEnterprise.Txt"}
would return only items that are Crystal reports, PDFs, or plain text files.
Note: For more information on BusinessObjects Enterprise ProgIDs, see the BusinessObjects Enterprise Java SDK Guide.
The searchFields
and searchText
properties must be used together to perform a wildcard search on the BusinessObjects Enterprise system. Set the searchFields
property to the field you wish to search on, and set the searchText
property to the text you want to match for. For example, set the searchFields
property to Name
and the searchText
property to World Sales Report
to search for reports with a name of "World Sales Report". Only certain fields are optimized and recommended for searching:
Several other properties control specific aspects of querying for collections of objects. Set the filterByOwner
property to true
to query only for items owned by the user. By default, this property is false
. The instances
property determines whether instances are included in the collection of objects returned and set to the EnterpriseItems
bean. This property must be set to fields of the com.businessobjects.jsf.sdk.properties.InstanceFilter
class: IncludeInstances
, to include instances in the query results; ExcludeInstances
, to exclude instances from the query results; and InstancesOnly
, to return a collection that contains only instances of objects.
In addition to the general attributes of the bean, two properties access classes that contain further properties:
sortBy
property
The sortBy
property gets or sets an instance of a SortProps
class that contains properties for specifying how items in the collection are sorted within the EnterpriseItems
bean. The sortField
property of the SortProps
class specifies the field by which the items in the collection are sorted on, and the sortDirection
property of the SortProps
class specifies whether the items are sorted in ascending or descending alphanumeric order.
Note: The ItemsGrid
component dictates the sorting property values for an EnterpriseItems
bean bound to the component. You must not change these values on an EnterpriseItems
bean manually at design time if attached to an ItemsGrid
component.
paging
property
The paging
property gets or sets an instance of a PagingProps
class that contains properties for specifying how a user pages through lists of items represented by the EnterpriseItems
bean. By default, paging is disabled. To enable paging and allow the user to navigate through pages of items, use the setEnabled
method of the PagingProps class with an argument of true
. The number of items visible to the user on each page is determined by the pageSize
property. The default value is to display ten items on the page at a time. The rangeSize
property specifies the number of pages that define a page range. For example, if the setRangeSize
method is used with an argument of 10, and the EnterpriseItems
bean is bound to an ItemsGrid
component, then the user can individually select pages 1
Note: For a comprehensive reference of all EnterpriseItems
bean members, see the IEnterpriseItems
interface in the JavaServer Faces Components for BusinessObjects Enterprise Java API Reference.
<managed
<description>Source for a collection of folders.</description>
<managed
<managed
com.businessobjects.jsf.appcontrols.model.EnterpriseItems
</managed
<managed
<managed
<property
<value>0</value>
</managed
</managed
Business Objects http://www.businessobjects.com/ Support services http://www.businessobjects.com/services/support/ |