Favorite Tool

The Favorite tool is a BI Beans thin bean, for use in an HTML-client application. It allows users to choose a page dimension member to display in a thin Dataview.

To use the Favorite tool, you must use BI Beans OLAP beans to specify data for a view.

The ThinBeanUI implementation of the Favorite tool is the oracle.dss.thin.beans.tools.query.FavoriteTool class. The UINode for the Favorite tool is oracle.dss.thin.beans.tools.query.FavoriteToolBean. To render the Favorite tool, your servlet application must associate the FavoriteTool object with the FavoriteToolBean object.

The JSP tag for this tool is the FavoriteTool tag. In the UIX Language, the definition element is the favoriteToolDef element, and the UINode is the favoriteTool element.

The FavoriteTool should be stored in the HTTP session.

Using the Favorite tool in the View Toolbar

When you use the View Toolbar, you do not need to instantiate a FavoriteTool or the FavoriteToolBean. The View Toolbar instantiates and renders the Favorite tool and handles its events.

Using the Favorite tool by itself

To use the Favorite tool outside of the View Toolbar, instantiate the FavoriteTool and call its setView method to specify the thin presentation bean that is displayed with the tool.

Events that this bean generates

The FavoriteTool generates the APPLY_FAVORITE_EVENT, which is defined in the oracle.dss.thin.BIConstants interface. The FavoriteTool also handles this event.

Events that this bean handles

The FavoriteTool handles the APPLY_FAVORITE_EVENT by applying the Selection that the FAVORITE parameter specifies to the specified dimension, in the Query that the view displays.