ObjectList JSP Tag Attributes

The ObjectList JSP tag is a BI Beans list tag that lets you define a list of objects. You can also specify presentations that are to be updated by this list.

An ObjectList can be a target of a FolderList tag so that the selection of a folder triggers an update of the objects that appear in the ObjectList.

If an ObjectList is not a target of a FolderList, then you specify the contents of the object list in one of the following ways:

Attributes

additionalAttributes -- A delimited string of Catalog attributes to fetch in addition to the attributes that are already required for the search.

id -- (Required) A unique identifier for this tag.

includeShortcuts -- Indicates whether to include shortcut objects in a list that results from a Catalog search. Default value is False.

includeTypes -- Specifies the object types that are allowed for this list. Valid values are: Crosstab, Graph, and Folder. If this attribute is not set, then only presentations (that is, crosstabs and graphs) are allowed.

itemLabelFormat -- Format for each item that is to be displayed in this list; includes the option of selecting the desired database name format for an item.

maxCount -- Maximum number of items in the list.

objects -- Predefined list of objects to produce a static list. All objects must be of the type that is specified in the includeTypes attribute. If you specify a value for this attribute, then all attributes that relate to searching the Catalog to produce a dynamic list are ignored.

partialTargets -- Tag identifiers of additional objects that this tag should update and include in a partial page refresh. Do not include objects that are specified in the targetPresentationIds attribute.

searchPathNames -- A name for each root that appears in the searchPaths attribute. This attribute is used only for dynamic lists.

searchPaths -- The full path of each folder from which to start searching for objects that are to be included in a dynamic list. If no value is specified for this attribute, then the BI Beans Catalog root is used as the starting point.

searchString -- Custom search string for locating objects that are to be included in a dynamic list. The search string allows the use of wildcard characters (*). For example, to find all objects that begin with the text "Sales", use the string: "Sales*".

searchSubfolders -- Indicates whether to search Catalog subfolders recursively when creating a dynamic list. Default value is True.

sortBy -- Name of any Catalog attribute that is to be used for sorting the objects in this list.

sortOrder -- Specifies the sort sequence for objects in this list: Ascending or Descending.

targetPresentationId -- The presentation tag, if any, to which the current selection of the list is to be applied.