oracle.dss.thin.beans.tools.query
Class FavoriteTool

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.tools.BaseViewTool
              |
              +--oracle.dss.thin.beans.tools.query.FavoriteTool

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI, ViewTool

public class FavoriteTool

extends BaseViewTool

Use the FavoriteTool to apply a favorite (that is, a saved selection) to a view. The FavoriteTool can be used by itself or with ViewToolbar.

For the FavoriteTool to function properly, the DataSource of the view must extend Query.

The FavoriteTool generates the BIConstants.APPLY_FAVORITE_EVENT event when a user chooses the Go button.

The FavoriteTool handles the BIConstants.APPLY_FAVORITE_EVENT event, which is generated when a user chooses the Go button. When this event occurs, the FavoriteTool applies the specified saved selection to the query for the view.

For more information about using the FavoriteTool, see the "Favorite Tool" topic in the BI Beans Help system.

See Also:

ViewTool, ViewToolbar, Query

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

FavoriteTool()
Constructor.

Method Summary

BIContext	getBIContext() Retrieves the BIContext for the FavoriteTool.
oracle.cabo.ui.UINode	getContentUINode() Retrieves the UINode that was used to render this ViewTool
java.lang.String	getCurrentDimension() Retrieves the current dimension for the FavoritesUI.
java.lang.String	getDisplayName() Retrieves the name that is used to display this tool on the ViewToolbar
int	handleEvent(QueryParameterProvider provider) An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request.
boolean	isEnabled() Indicates whether the FavoriteTool's link appears on the toolbar.
void	setBIContext(BIContext biContext) Specifies the BIContext for the FavoriteTool.
void	setCurrentDimension(java.lang.String currentDimension) Specifies the current dimension for the FavoritesUI.
void	setView(ThinDataviewCommon view) Specifies the view that was modified by this FavoriteTool.

Methods inherited from class oracle.dss.thin.beans.tools.BaseViewTool

addViewToolListener, getDestination, getToolbarName, getView, isVisible, removeViewToolListener, setDestination, setDisplayName, setEnabled, setToolbarName, setVisible

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.dss.thin.beans.ThinBeanUI

getEventTarget, getLocale, setEventTarget, setLocale

Methods inherited from interface oracle.dss.thin.beans.ThinBean

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Constructor Detail

FavoriteTool

public FavoriteTool()

Constructor.

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

An application's servlet must call handleEvent, when a ThinBean event triggered the servlet request. To determine the correct ThinBean to call handleEvent() on, the application should check the "source" query parameter, which will be the ThinBeanName of the ThinBean that rendered the URL/Form in HTML and which also needs to handle the event. The application can also choose to call handleEvent on all of its ThinBeanUI components and check the return value of handleEvent() to determine which component has handled the event. Each ThinBeanUI component needs to check the source parameter to make sure that it matches their ThinBeanName. If it does not match, then the event should not be processed.

Parameters:

provider - An instance of a QueryParameterProvider that returns decoded and unescaped query parameter values from HTTPServletRequests

Returns:

EVENT_NOT_HANDLED, EVENT_HANDLED, or EVENT_RESPONSE_DONE

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE

getBIContext

public BIContext getBIContext()

Retrieves the BIContext for the FavoriteTool.

Returns:

an implementation of the oracle.dss.bicontext.BIContext interface

setBIContext

public void setBIContext(BIContext biContext)

Specifies the BIContext for the FavoriteTool.

Parameters:

biContext - an implementation of the oracle.dss.bicontext.BIContext interface

setView

public void setView(ThinDataviewCommon view)

Specifies the view that was modified by this FavoriteTool.

Overrides:

setView in class BaseViewTool

Parameters:

a - view that implements the ThinDataviewCommon interface

getCurrentDimension

public java.lang.String getCurrentDimension()

Retrieves the current dimension for the FavoritesUI. Only the favorites for the current dimension are displayed.

Returns:

the name of the current dimension as a String

setCurrentDimension

public void setCurrentDimension(java.lang.String currentDimension)

Specifies the current dimension for the FavoritesUI.

Parameters:

current - dimension String name

getContentUINode

public oracle.cabo.ui.UINode getContentUINode()

Retrieves the UINode that was used to render this ViewTool

Returns:

UINode used to render this view tool

getDisplayName

public java.lang.String getDisplayName()

Retrieves the name that is used to display this tool on the ViewToolbar

Overrides:

getDisplayName in class BaseViewTool

Returns:

tool display name

See Also:

ViewToolbar

isEnabled

public boolean isEnabled()

Indicates whether the FavoriteTool's link appears on the toolbar. When the current View's DataSource is not an instance of an OLAP Query, the FavoriteTool becomes disabled and does not appear on the toolbar.

Overrides:

isEnabled in class BaseViewTool

Returns:

true if enabled, false otherwise

See Also:

ViewToolbar