Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.thin.beans
Interface BIConstants


public interface BIConstants

The BIConstants interface contains constants for:


Field Summary
static java.lang.String APPLY_FAVORITE_EVENT
          Thin-bean event: Apply a favorite to a dimension.
static java.lang.String BI_NAMESPACE
          The UIX Namespace for the BI Beans thin beans.
static java.lang.String BI_PREFIX
          All BI event parameter names are prefixed with BI_PREFIX, except for SOURCE, EVENT, and VALUE.
static java.lang.String BICONTEXT_ATTR
          The attribute name for the BI Beans Catalog context.
static java.lang.String CANCEL_EVENT
          Thin-bean event: Cancel.
static java.lang.String COLLAPSE_FOLDER_EVENT
          Thin-bean event: Collapse selected folder to hide subfolders.
static java.lang.String COLNAV
          Thin-bean event parameter: Column navigation.
static java.lang.String COLUMN
          Thin-bean event parameter: Column.
static java.lang.String COLUMN_SORT_EVENT
          Thin-bean event: Sort a specified column in the ExplorerDetail or ExplorerSearch.
static java.lang.String COLUMN_SORT_STATE
          Thin-bean event parameter: Sort state of a column.
static java.lang.String COLUMN_SORT_VALUE
          Thin-bean event parameter: Column sort value.
static java.lang.String CROSSTAB_NAME
          The local name of the oracle.dss.thin.beans.crosstab.CrosstabBean.
static java.lang.String DATADRILL_EVENT
          Thin-bean event: Drill out from the databody.
static java.lang.String DELETE_EVENT
          Thin-bean event: Delete the selected object.
static java.lang.String DESCRIPTION
          Thin-bean event parameter: Description Identifies a description of a presentation bean that is being saved in the BI Beans Catalog.
static java.lang.String DIMENSION
          Thin-bean event parameter: Dimension.
static java.lang.String DRILL_EVENT
          Thin-bean event: Drill.
static java.lang.String EDGE
          Thin-bean event parameter: Edge.
static java.lang.String ERROR_DIALOG_NAME
          The local name of the errorDialog.
static java.lang.String EVENT
          Thin-bean event parameter: Event that needs to be handled.
static java.lang.String EXPAND_FOLDER_EVENT
          Thin-bean event: Expand the selected folder to show subfolders.
static java.lang.String EXPLORER_DETAIL_NAME
          The local name of the oracle.dss.thin.beans.persistence.ExplorerDetailBean.
static java.lang.String EXPLORER_QUICK_SEARCH_NAME
          The local name of the oracle.dss.thin.beans.persistence.ExplorerQuickSearchBean.
static java.lang.String EXPLORER_SEARCH_NAME
          The local name of the oracle.dss.thin.beans.persistence.ExplorerSearchBean.
static java.lang.String EXPLORER_TREE_NAME
          The local name of the oracle.dss.thin.beans.persistence.ExplorerTreeBean.
static java.lang.String EXPORT_EVENT
          Thin-bean event: Export data.
static java.lang.String EXPORT_FORMAT
          Thin-bean event parameter: Export format.
static java.lang.String EXPORT_OPTIONS_NAME
          The local name of the oracle.dss.thin.beans.dataView.ExportOptionsBean.
static java.lang.String FAVORITE
          Thin-bean event parameter: Favorite.
static java.lang.String FAVORITE_TOOL_NAME
          The local name of the oracle.dss.thin.beans.tools.query.FavoriteToolBean.
static java.lang.String FILTER_EVENT
          Thin-bean event: Filter the displayed folders or objects.
static java.lang.String FILTER_TYPE
          Thin-bean event parameter: Filter type.
static java.lang.String FIND_MEMBER_NAME
          The local name of the oracle.dss.thin.beans.dataView.FindMemberBean.
static java.lang.String FLAG
          Thin-bean event parameter: Flag.
static java.lang.String FROM
          Thin-bean event parameter: From.
static java.lang.String FULL_PATH_NAME
          Thin-bean event parameter: Full path name.
static java.lang.String GOTO_ROW_EVENT
          Thin-bean event: Go to row.
static java.lang.String GRAPH_NAME
          The local name of the oracle.dss.thin.beans.graph.GraphBean.
static java.lang.String GRAPH_SUBTYPE
          Thin-bean event parameter: Graph subtype.
static java.lang.String GRAPH_TYPE
          Thin-bean event parameter: Graph type.
static java.lang.String HEADERDRILL_EVENT
          Thin-bean event: Drill out from a header in a thin table or crosstab.
static java.lang.String HIDE_TOOLS_EVENT
          Thin-bean event: Hide tools.
static java.lang.String INIT_EVENT
          Thin-bean event: Initialize the thin bean.
static java.lang.String INIT_FIND_MEMBER_EVENT
          Thin-bean event: Display Find Member dialog.
static java.lang.String INIT_PRINTER_FRIENDLY_VIEW_EVENT
          Thin-bean event: Display Printer-Friendly View.
static java.lang.String KEYWORDS
          Thin-bean event parameter: Keywords.
static java.lang.String LAYER
          Thin-bean event parameter: Layer.
static java.lang.String LOCATION
          Thin-bean event parameter: Location.
static int MEASURE_ITEM_LIMIT
          Maximum number of graph measure items.
static java.lang.String MEASURE_ITEM_NUM
          Thin-bean event parameter: Measure Item Number.
static java.lang.String MEASURE_LAYOUT_EVENT
          Thin-bean event: Change Measure Layout.
static java.lang.String MEASURE0
          Thin-bean event parameter: Measure0.
static java.lang.String MEASURE1
          Thin-bean event parameter: Measure1.
static java.lang.String MEASURE2
          Thin-bean event parameter: Measure2.
static java.lang.String MEASURE3
          Thin-bean event parameter: Measure3.
static java.lang.String MEASURE4
          Thin-bean event parameter: Measure4.
static java.lang.String MOVE
          Thin-bean event parameter value: Move.
static char MOVE_AFTER
          Thin-bean event parameter value: Move after.
static char MOVE_BEFORE
          Thin-bean event parameter value: Move before.
static java.lang.String NAV_LAYER
          Thin-bean event parameter value: Layer.
static java.lang.String NAV_SLICE
          Thin-bean event parameter value: Slice.
static java.lang.String NEXT_COLS_EVENT
          Thin-bean event.
static java.lang.String NEXT_ROWS_EVENT
          Thin-bean event.
static java.lang.String OBJECT_TYPE
          Thin-bean event parameter: Object type.
static java.lang.String OPERATION
          Thin-bean event parameter: Operation.
static java.lang.String ORIGIN
          Thin-bean event parameter: Origin This parameter identifies the bean that generated the event.
static java.lang.String PAGE_EVENT
          Thin-bean event: Display a different logical page.
static java.lang.String PAGE_RANGE
          Thin-bean event parameter: Page range.
static java.lang.String PRESENTATION_NAME
          The local name of the presentation.
static java.lang.String PREVIOUS_COLS_EVENT
          Thin-bean event.
static java.lang.String PREVIOUS_ROWS_EVENT
          Thin-bean event.
static java.lang.String PRINT_COLUMN_BLOCK_SIZE
          Thin-bean event parameter: Column block size.
static java.lang.String PRINT_OPTIONS_NAME
          The local name of the oracle.dss.thin.beans.dataView.PrintOptionsBean.
static java.lang.String PRINT_PAPER_ORIENTATION
          Thin-bean event parameter: Paper orientation.
static java.lang.String PRINT_PAPER_SIZE
          Thin-bean event parameter: Paper size.
static java.lang.String PRINT_ROW_BLOCK_SIZE
          Thin-bean event parameter: Row block size.
static java.lang.String PRINTER_FRIENDLY_VIEW_NAME
          The local name of the oracle.dss.thin.beans.dataView.PrinterFriendlyBean.
static java.lang.String ROTATE_EVENT
          Thin-bean event: Rotate.
static java.lang.String ROTATE_TOOL_NAME
          The local name of the oracle.dss.thin.beans.tools.RotateToolBean
static java.lang.String ROW
          Thin-bean event parameter: Row.
static java.lang.String ROWNAV
          Thin-bean event parameter: Row navigation.
static java.lang.String SAVE_CONFIRMATION_NAME
          The local name of the oracle.dss.thin.beans.dataView.SaveConfirmationBean.
static java.lang.String SAVE_EVENT
          Thin-bean event: Save.
static java.lang.String SAVE_NAME
          Thin-bean event parameter: Name to save under.
static java.lang.String SAVE_OVERWRITE
          Thin-bean event parameter: Overwrite an existing item in the Catalog.
static java.lang.String SAVE_OVERWRITE_NO
          Thin-bean-event parameter value: Do not overwrite an existing presentation bean.
static java.lang.String SAVE_OVERWRITE_YES
          Thin-bean-event parameter value: Do overwrite an existing presentation bean.
static java.lang.String SAVEAS_NAME
          The local name of the oracle.dss.thin.beans.dataView.SaveAsBean.
static java.lang.String SEARCH_CRITERION
          Thin-bean event parameter: Search criterion.
static java.lang.String SEARCH_EVENT
          Thin-bean event: Search for objects that meet a criterion.
static java.lang.String SEARCH_STRING
          Thin-bean event parameter: Search string.
static java.lang.String SELECT_FOLDER_EVENT
          Thin-bean event: Select folder.
static java.lang.String SELECT_OBJECT_EVENT
          Thin-bean event: Select object.
static java.lang.String SHOW_TOOL_EVENT
          Thin-bean event: Change the type of view that displays data.
static java.lang.String SLICE
          Thin-bean event parameter: Slice.
static java.lang.String SORT_CRITERION
          Thin-bean event parameter: Sort criterion.
static java.lang.String SORT_DIMENSION
          Thin-bean event parameter: Sort dimension.
static java.lang.String SORT_EVENT
          Thin-bean event: Sort dimension members.
static java.lang.String SORT_ORDER
          Thin-bean event parameter: Sort order.
static java.lang.String SORT_QUALIFIER
          Thin-bean event parameter: Sort qualifier.
static java.lang.String SORT_TOOL_NAME
          The local name of the oracle.dss.thin.beans.tools.query.SortToolBean.
static java.lang.String SOURCE
          Query parameter: Object that should handle a thin-bean event.
static java.lang.String SUBMIT_FOLDER_EVENT
          Thin-bean event: Submit folder.
static java.lang.String SWAP
          Thin-bean event parameter value: Swap.
static java.lang.String TABLE_NAME
          The local name of the oracle.dss.thin.beans.table.TableBean.
static java.lang.String TO
          Thin-bean event parameter: To.
static java.lang.String TOOL
          Thin-bean event parameter: Tool.
static java.lang.String VALUE
          Thin-bean event parameter: Value.
static java.lang.String VIEW_TOOLBAR_NAME
          The local name of the oracle.dss.thin.beans.toolbar.ViewToolbarBean.
static java.lang.String VIEW_TYPE
          Thin-bean event parameter: Type of view.
static java.lang.String VIEW_TYPE_CHANGED_EVENT
          Thin-bean event: Change the type of view that displays data.
static java.lang.String VIEW_TYPE_TOOL_NAME
          The local name of the oracle.dss.thin.beans.tools.ViewTypeBean.

 

Field Detail

BICONTEXT_ATTR

public static final java.lang.String BICONTEXT_ATTR
The attribute name for the BI Beans Catalog context. Thin presentation beans use the value of this attribute to find the BI Beans Catalog context, BIContext on the QueryParameterProvider. Thin presentation beans use the BIContext when they handle SAVE_EVENT events.

By default, the ServletQueryParameterProvider fetches attributes from the current HttpSession. You can store the BIContext in the HttpSession by calling HttpSession.putValue.

See Also:
ServletQueryParameterProvider, QueryParameterProvider, ThinDataviewCommon, BIContext

BI_NAMESPACE

public static final java.lang.String BI_NAMESPACE
The UIX Namespace for the BI Beans thin beans.

CROSSTAB_NAME

public static final java.lang.String CROSSTAB_NAME
The local name of the oracle.dss.thin.beans.crosstab.CrosstabBean.

TABLE_NAME

public static final java.lang.String TABLE_NAME
The local name of the oracle.dss.thin.beans.table.TableBean.

GRAPH_NAME

public static final java.lang.String GRAPH_NAME
The local name of the oracle.dss.thin.beans.graph.GraphBean.

EXPLORER_TREE_NAME

public static final java.lang.String EXPLORER_TREE_NAME
The local name of the oracle.dss.thin.beans.persistence.ExplorerTreeBean.

EXPLORER_DETAIL_NAME

public static final java.lang.String EXPLORER_DETAIL_NAME
The local name of the oracle.dss.thin.beans.persistence.ExplorerDetailBean.

EXPLORER_QUICK_SEARCH_NAME

public static final java.lang.String EXPLORER_QUICK_SEARCH_NAME
The local name of the oracle.dss.thin.beans.persistence.ExplorerQuickSearchBean.

EXPLORER_SEARCH_NAME

public static final java.lang.String EXPLORER_SEARCH_NAME
The local name of the oracle.dss.thin.beans.persistence.ExplorerSearchBean.

SAVEAS_NAME

public static final java.lang.String SAVEAS_NAME
The local name of the oracle.dss.thin.beans.dataView.SaveAsBean.

VIEW_TOOLBAR_NAME

public static final java.lang.String VIEW_TOOLBAR_NAME
The local name of the oracle.dss.thin.beans.toolbar.ViewToolbarBean.

VIEW_TYPE_TOOL_NAME

public static final java.lang.String VIEW_TYPE_TOOL_NAME
The local name of the oracle.dss.thin.beans.tools.ViewTypeBean.

ROTATE_TOOL_NAME

public static final java.lang.String ROTATE_TOOL_NAME
The local name of the oracle.dss.thin.beans.tools.RotateToolBean

SORT_TOOL_NAME

public static final java.lang.String SORT_TOOL_NAME
The local name of the oracle.dss.thin.beans.tools.query.SortToolBean.

FAVORITE_TOOL_NAME

public static final java.lang.String FAVORITE_TOOL_NAME
The local name of the oracle.dss.thin.beans.tools.query.FavoriteToolBean.

EXPORT_OPTIONS_NAME

public static final java.lang.String EXPORT_OPTIONS_NAME
The local name of the oracle.dss.thin.beans.dataView.ExportOptionsBean.

PRINT_OPTIONS_NAME

public static final java.lang.String PRINT_OPTIONS_NAME
The local name of the oracle.dss.thin.beans.dataView.PrintOptionsBean.

PRINTER_FRIENDLY_VIEW_NAME

public static final java.lang.String PRINTER_FRIENDLY_VIEW_NAME
The local name of the oracle.dss.thin.beans.dataView.PrinterFriendlyBean.

FIND_MEMBER_NAME

public static final java.lang.String FIND_MEMBER_NAME
The local name of the oracle.dss.thin.beans.dataView.FindMemberBean.

SAVE_CONFIRMATION_NAME

public static final java.lang.String SAVE_CONFIRMATION_NAME
The local name of the oracle.dss.thin.beans.dataView.SaveConfirmationBean.

ERROR_DIALOG_NAME

public static final java.lang.String ERROR_DIALOG_NAME
The local name of the errorDialog.

PRESENTATION_NAME

public static final java.lang.String PRESENTATION_NAME
The local name of the presentation.

BI_PREFIX

public static final java.lang.String BI_PREFIX
All BI event parameter names are prefixed with BI_PREFIX, except for SOURCE, EVENT, and VALUE. These exceptions are defined by UIX.

In addition, all BI event names are prefixed with BI_PREFIX, except for GOTO_ROW_EVENT, which is actually generated by the UIX Navigation Control that the ThinTable uses internally.

See Also:
SOURCE, EVENT, VALUE, GOTO_ROW_EVENT, ThinTable

SOURCE

public static final java.lang.String SOURCE
Query parameter: Object that should handle a thin-bean event. Conceptually, SOURCE identifies the target of a thin-bean event. The name SOURCE follows a UIX query parameter naming convention, which is used by the several native UIX components to indicate which component generated an event.

Some thin beans support event targets, which allow you to route the event to a different bean. When you set an event target, the thinBeanTarget that you specify will be set as the source query parameter for the event.

UIX Controller applications can use this parameter to route events to the correct UIX event handlers.

The literal value of SOURCE is "source".

See Also:
EventTarget

EVENT

public static final java.lang.String EVENT
Thin-bean event parameter: Event that needs to be handled. This query parameter name is equivalent to the UIX query parameter that identifies the type of event. UIX Controller applications can use this parameter to route events. For BI Beans thin-bean events, the event will be an event type that is defined in this interface.

The literal value of EVENT is "event".


VALUE

public static final java.lang.String VALUE
Thin-bean event parameter: Value. For the GOTO_ROW_EVENT, the VALUE parameter identifies the row.

This parameter name is equivalent to the UIX query parameter that is generated from oracle.cabo.ui.beans.nav.NavigationBarBean events, because BI Beans internally uses the NavigationBarBean.

The literal value of VALUE is "value".

See Also:
GOTO_ROW_EVENT

GOTO_ROW_EVENT

public static final java.lang.String GOTO_ROW_EVENT
Thin-bean event: Go to row. This event is a possible value of the EVENT query parameter. It has the VALUE parameter, which identifies the row to go to.

This event is handled by the same thin bean that generates the event.

This event type is equivalent to the UIX event parameter that is generated from oracle.cabo.ui.beans.nav.NavigationBarBean events, because BI Beans internally uses the NavigationBarBean.

The literal value of GOTO_ROW_EVENT is "goto".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch, FindMember, ThinCrosstab, ThinTable

PREVIOUS_COLS_EVENT

public static final java.lang.String PREVIOUS_COLS_EVENT
Thin-bean event. Go to previous column. This event is a possible value of the EVENT query parameter. This event is generated and handled by thin crosstab.

This event has the following parameter:

The literal value of PREVIOUS_COLS_EVENT is "bi_prevcols".

See Also:
ThinCrosstab

NEXT_COLS_EVENT

public static final java.lang.String NEXT_COLS_EVENT
Thin-bean event. Go to next column. This event is a possible value of the EVENT query parameter. This event is generated and handled by thin crosstab.

This event has the following parameter:

The literal value of NEXT_COLS_EVENT is "bi_nextcols".

See Also:
ThinCrosstab

PREVIOUS_ROWS_EVENT

public static final java.lang.String PREVIOUS_ROWS_EVENT
Thin-bean event. Go to previous row This event is a possible value of the EVENT query parameter. This event is generated and handled by thin crosstab.

This event has the following parameter:

The literal value of PREVIOUS_ROWS_EVENT is "bi_prevrows".

See Also:
ThinCrosstab

NEXT_ROWS_EVENT

public static final java.lang.String NEXT_ROWS_EVENT
Thin-bean event. Go to next row This event is a possible value of the EVENT query parameter. This event is generated and handled by thin crosstab.

This event has the following parameter:

The literal value of NEXT_ROWS_EVENT is "bi_nextrows".

See Also:
ThinCrosstab

COLNAV

public static final java.lang.String COLNAV
Thin-bean event parameter: Column navigation. This is a parameter of the NEXT_COLS_EVENT and of the PREVIOUS_COLS_EVENT. The format of the parameter value is one of following:

The literal value of COLNAV is "bi_colnav".

See Also:
NEXT_COLS_EVENT, PREVIOUS_COLS_EVENT

ROWNAV

public static final java.lang.String ROWNAV
Thin-bean event parameter: Row navigation. This is a parameter of the NEXT_ROWS_EVENT and of the PREVIOUS_ROWS_EVENT. The format of the parameter value is one of following:

The literal value of ROWNAV is "bi_rownav".

See Also:
NEXT_ROWS_EVENT, PREVIOUS_ROWS_EVENT

NAV_SLICE

public static final java.lang.String NAV_SLICE
Thin-bean event parameter value: Slice. This is part of a potential value of the COLNAV and ROWNAV parameters.

The literal value of NAV_SLICE is "s".


NAV_LAYER

public static final java.lang.String NAV_LAYER
Thin-bean event parameter value: Layer. This is part of a potential value of the COLNAV and ROWNAV parameters.

The literal value of NAV_LAYER is "l".


INIT_EVENT

public static final java.lang.String INIT_EVENT
Thin-bean event: Initialize the thin bean. This event is a possible value of the EVENT query parameter. This event is handled by the following thin dialogs:

This event is generated by the OnClick javascript handler on an application-defined link, such as a button or a link. The InitEventDataObject generates the javascript for the OnClick handler.

Your application can handle this event by instantiating the thin dialog, or you can handle the Java InitEvent that an instantiated thin dialog fires.

For more information on handling this event, see the BI Beans Help system.

The literal value of INIT_EVENT is "bi_init".

See Also:
INIT_FIND_MEMBER_EVENT, INIT_PRINTER_FRIENDLY_VIEW_EVENT, InitEventDataObject, SaveAs, SaveConfirmation, PrintOptions, ExportOptions

ROTATE_EVENT

public static final java.lang.String ROTATE_EVENT
Thin-bean event: Rotate. This event is a possible value of the EVENT query parameter. This event is generated by the RotateTool, and it is handled by the thin presentation beans.

This event has the following parameters:

The literal value of ROTATE_EVENT is "bi_rotate".

See Also:
RotateTool, ThinDataviewCommon

MEASURE_LAYOUT_EVENT

public static final java.lang.String MEASURE_LAYOUT_EVENT
Thin-bean event: Change Measure Layout. This event is a possible value of the EVENT query parameter. This event is generated by the RotateTool, and it is handled by the thin graph.

This event has the following parameters:

The literal value of MEASURE_LAYOUT_EVENT is "bi_measrl".

See Also:
RotateTool, ThinDataviewCommon

DRILL_EVENT

public static final java.lang.String DRILL_EVENT
Thin-bean event: Drill. This event is a possible value of the EVENT query parameter. This event is generated and handled by thin presentation beans. Internally, it is mapped to the oracle.dss.util.DataDirector.drill method. The DRILL event has the following parameters:

The literal value of DRILL_EVENT is "bi_drill".

See Also:
ThinDataviewCommon, DataDirector.drill(int, int, int, int)

PAGE_EVENT

public static final java.lang.String PAGE_EVENT
Thin-bean event: Display a different logical page. This event is a possible value of the EVENT query parameter. This event is generated by thin presentation beans and by the Find Member bean. It is handled by the thin presentation beans. Internally, the event is mapped to the oracle.dss.util.DataDirector.changeEdgeCurrentHPos method.

This event has a BI_PREFIX parameter for each page dimension in the data that the thin presentation bean displays. The format for each parameter is BI_PREFIX+layer_index+thin_bean_name. The set of parameters is an array of relative indexes, starting with layer 0 and working in to layer N. The array indicates the set of new values to give to the various layers that specify the new current page slice.

The literal value of PAGE_EVENT is "bi_page".

See Also:
DataDirector.changeEdgeCurrentHPos(int, int[], int), ThinDataviewCommon, FindMember

EXPORT_EVENT

public static final java.lang.String EXPORT_EVENT
Thin-bean event: Export data. This event is a possible value of the EVENT query parameter. This event is generated by the ExportOptions object. This event is handled by the ThinTable and the ThinCrosstab. This event has the following parameters:

This event supports event targets.

The literal value of EXPORT_EVENT is "bi_export".

See Also:
EventTarget, ExportOptions, ThinDataviewCommon

SAVE_EVENT

public static final java.lang.String SAVE_EVENT
Thin-bean event: Save. This event is a possible value of the EVENT query parameter. This event is generated by the SaveAs object and by the SaveConfirmation object. It is handled by the thin presentation beans. This event has the following parameters:

This event supports event targets.

The literal value of SAVE_EVENT is "bi_save".

See Also:
EventTarget, SaveAs, ThinDataviewCommon

DATADRILL_EVENT

public static final java.lang.String DATADRILL_EVENT
Thin-bean event: Drill out from the databody. This event is a possible value of the EVENT query parameter. This event is generated by thin tables and crosstabs. It is handled by a GridViewDataListener that you set on the thin crosstab or table. This event has the following parameters:

The literal value of DATADRILL_EVENT is "bi_dataDrill".

See Also:
ThinGridView

HEADERDRILL_EVENT

public static final java.lang.String HEADERDRILL_EVENT
Thin-bean event: Drill out from a header in a thin table or crosstab. This event is a possible value of the EVENT query parameter. This event is generated by thin tables and crosstabs. It is handled by a GridViewDataListener that you set on the thin crosstab or table. This event has the following parameters:

The literal value of HEADERDRILL_EVENT is "bi_headerDrill".

See Also:
ThinGridView

INIT_FIND_MEMBER_EVENT

public static final java.lang.String INIT_FIND_MEMBER_EVENT
Thin-bean event: Display Find Member dialog. This event is a possible value of the EVENT query parameter. Typically, it is generated by thin presentation beans in which the paging control is visible. It is handled by the FindMember object. You must set an event target on the thin presentation bean that directs this event to a FindMember. If you do not, then this event will not occur, and users will not have a way to see more than the first 25 dimension members in the paging control.

The event has the following parameters:

The literal value of INIT_FIND_MEMBER_EVENT is "bi_initFM". For more information on using the Find Member dialog, see the BI Beans Help system.

See Also:
INIT_EVENT, INIT_PRINTER_FRIENDLY_VIEW_EVENT, EventTarget, FindMember

INIT_PRINTER_FRIENDLY_VIEW_EVENT

public static final java.lang.String INIT_PRINTER_FRIENDLY_VIEW_EVENT
Thin-bean event: Display Printer-Friendly View. This event is a possible value of the EVENT query parameter. The PrintOptions object generates this event, and the PrinterFriendlyView object handles it. You must set an EventTarget on the PrintOptions to route the event to the PrinterFriendlyView.

This event has the following parameters:

This event supports event targets.

The literal value of INIT_PRINTER_FRIENDLY_VIEW_EVENT is "bi_initPFV". For more information on using the Printer-Friendly View, see the BI Beans Help system.

See Also:
INIT_EVENT, INIT_FIND_MEMBER_EVENT, EventTarget, PrintOptions, PrinterFriendlyView

SELECT_OBJECT_EVENT

public static final java.lang.String SELECT_OBJECT_EVENT
Thin-bean event: Select object. This event is a possible value of the EVENT query parameter. The Explorer beans generate and handle this event. This event occurs when an object that is not a folder is selected. The Explorer beans handle the event by passing it to registered listeners, which can choose to perform a default action on the object, such as open. This event has the following parameters:

The literal value of SELECT_OBJECT_EVENT is "bi_select".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch

FILTER_EVENT

public static final java.lang.String FILTER_EVENT
Thin-bean event: Filter the displayed folders or objects. This event is a possible value of the EVENT query parameter. The Explorer beans generate and handle this event. This event has the following parameters:

The literal value of FILTER_EVENT is "bi_filter".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch

SELECT_FOLDER_EVENT

public static final java.lang.String SELECT_FOLDER_EVENT
Thin-bean event: Select folder. This event is a possible value of the EVENT query parameter. This event occurs when a folder is selected. The Explorer beans generate and handle this event.

ExplorerDetail and ExplorerSearch handle this event by displaying the contents of the selected folder. This event has the following parameter:

The literal value of SELECT_FOLDER_EVENT is "bi_selFolder".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch

SUBMIT_FOLDER_EVENT

public static final java.lang.String SUBMIT_FOLDER_EVENT
Thin-bean event: Submit folder. This event is a possible value of the EVENT query parameter. The ExplorerDetail bean generates this event. This event is handled by the SaveAs bean. This event has the following parameters: This event supports event targets.

The literal value of SUBMIT_FOLDER_EVENT is "bi_submitFolder".

See Also:
EventTarget, SaveAs, ExplorerDetail

DELETE_EVENT

public static final java.lang.String DELETE_EVENT
Thin-bean event: Delete the selected object. This event is a possible value of the EVENT query parameter. The ExplorerDetail and the ExplorerSearch generate and handle this event. They handle the event by passing it to registered listeners. You must implement an ExplorerListener that actually calls the PersistenceManager.unbind method to delete the object. This event has the following parameters:

The literal value of DELETE_EVENT is "bi_delete".

See Also:
ExplorerDetail, ExplorerSearch, PersistenceManager

SEARCH_EVENT

public static final java.lang.String SEARCH_EVENT
Thin-bean event: Search for objects that meet a criterion. This event is a possible value of the EVENT query parameter. The ExplorerTree and the ExplorerSearch generate and handle this event. This event has the following parameters:

The literal value of SEARCH_EVENT is "bi_search".

See Also:
ExplorerTree, ExplorerSearch

COLUMN_SORT_EVENT

public static final java.lang.String COLUMN_SORT_EVENT
Thin-bean event: Sort a specified column in the ExplorerDetail or ExplorerSearch. This event is a possible value of the EVENT query parameter. The ExplorerDetail generates and handles this event. This event has the following parameters:

The literal value of COLUMN_SORT_EVENT is "bi_colSort".

See Also:
ExplorerDetail

EXPAND_FOLDER_EVENT

public static final java.lang.String EXPAND_FOLDER_EVENT
Thin-bean event: Expand the selected folder to show subfolders. This event is a possible value of the EVENT query parameter. The ExplorerTree generates and handle this event. This event has the following parameters:

The literal value of EXPAND_FOLDER_EVENT is "bi_expand".

See Also:
ExplorerTree

COLLAPSE_FOLDER_EVENT

public static final java.lang.String COLLAPSE_FOLDER_EVENT
Thin-bean event: Collapse selected folder to hide subfolders. This event is a possible value of the EVENT query parameter. The ExplorerTree generates and handle this event. This event has the following parameters:

The literal value of COLLAPSE_FOLDER_EVENT is "bi_collapse".

See Also:
ExplorerTree

APPLY_FAVORITE_EVENT

public static final java.lang.String APPLY_FAVORITE_EVENT
Thin-bean event: Apply a favorite to a dimension. This event is a possible value of the EVENT query parameter. The Favorite Tool generates and handles this event. This event has the following parameters:

This tool requires that you use a subclass of the oracle.dss.dataSource.common.Query.

The literal value of APPLY_FAVORITE_EVENT is "bi_applyFav".

See Also:
FavoriteTool, Query

SORT_EVENT

public static final java.lang.String SORT_EVENT
Thin-bean event: Sort dimension members. This event is a possible value of the EVENT query parameter. The SortTool generates and handles this event. This event has the following parameters:

This tool requires that you use a subclass of the oracle.dss.dataSource.common.Query.

The literal value of SORT_EVENT is "bi_sort".

See Also:
SortTool, Query

VIEW_TYPE_CHANGED_EVENT

public static final java.lang.String VIEW_TYPE_CHANGED_EVENT
Thin-bean event: Change the type of view that displays data. This event is a possible value of the EVENT query parameter. The View Type Tool generates this event. It handles the event as well, by passing it to registered listeners. Your listener must instantiate the requested thin presentation bean. This event has the following parameters:

The literal value of VIEW_TYPE_CHANGED_EVENT is "bi_viewType".

See Also:
ViewTypeTool

HIDE_TOOLS_EVENT

public static final java.lang.String HIDE_TOOLS_EVENT
Thin-bean event: Hide tools. This event is a possible value of the EVENT query parameter. The ViewToolbar generates and handles this event. It has no parameters.

The literal value of HIDE_TOOLS_EVENT is "bi_hideTools".

See Also:
ViewToolbar

SHOW_TOOL_EVENT

public static final java.lang.String SHOW_TOOL_EVENT
Thin-bean event: Change the type of view that displays data. This event is a possible value of the EVENT query parameter. The ViewToolbar generates and handles this event. This event has the TOOL parameter.

The literal value of SHOW_TOOL_EVENT is "bi_showTool".

See Also:
ViewToolbar

CANCEL_EVENT

public static final java.lang.String CANCEL_EVENT
Thin-bean event: Cancel. This event is a possible value of the EVENT query parameter. The Cancel button or link that appears on a page with a thin dialogs generates this event. For the Find Member dialog, you do not have to handle this event. For other dialogs, you must set an EventTarget to route this event to your application. This event has no parameters.

This event supports event targets.

The literal value of CANCEL_EVENT is "bi_cancel".

For information about generating javascript for the Cancel button or link, see the BI Beans Help system.

See Also:
EventTarget, FindMember, PrintOptions, SaveAs, SaveConfirmation

ORIGIN

public static final java.lang.String ORIGIN
Thin-bean event parameter: Origin This parameter identifies the bean that generated the event. It is used to identify uniquely the other parameters for the event. It identifies parameters that are retrieved from form controls and not from hidden form fields. This is a parameter of the EXPORT_EVENT, the SAVE_EVENT, the INIT_PRINTER_FRIENDLY_VIEW_EVENT, the FILTER_EVENT, the SEARCH_EVENT, the APPLY_FAVORITE_EVENT, the SORT_EVENT, and the COLUMN_SORT_EVENT.

The literal value of ORIGIN is "bi_origin".


FROM

public static final java.lang.String FROM
Thin-bean event parameter: From. This is a parameter of the ROTATE_EVENT. This parameter identifies one or the other of the following:

The literal value of FROM is "bi_from".

See Also:
RotateTool

TO

public static final java.lang.String TO
Thin-bean event parameter: To. This is a parameter of the ROTATE_EVENT. This parameter identifies one of the following:

The literal value of TO is "bi_to".

See Also:
RotateTool, MOVE_BEFORE, MOVE_AFTER, DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE

OPERATION

public static final java.lang.String OPERATION
Thin-bean event parameter: Operation. Specifies whether to move or swap the locations that are identified in the FROM and TO event parameters. The possible values for this parameter are MOVE or SWAP This is a parameter of the ROTATE_EVENT.

The literal value of OPERATION is "bi_op".

See Also:
RotateTool

SWAP

public static final java.lang.String SWAP
Thin-bean event parameter value: Swap.

The literal value of SWAP is "swap".


MOVE

public static final java.lang.String MOVE
Thin-bean event parameter value: Move.

The literal value of MOVE is "move".


MOVE_BEFORE

public static final char MOVE_BEFORE
Thin-bean event parameter value: Move before.

The literal value of MOVE_BEFORE is "0".


MOVE_AFTER

public static final char MOVE_AFTER
Thin-bean event parameter value: Move after.

The literal value of MOVE_AFTER is "1".


MEASURE_ITEM_LIMIT

public static final int MEASURE_ITEM_LIMIT
Maximum number of graph measure items. This constant identifies the maximum number of measures for which the ROTATE_EVENT defines the layout in a thin graph.
See Also:
RotateTool

MEASURE_ITEM_NUM

public static final java.lang.String MEASURE_ITEM_NUM
Thin-bean event parameter: Measure Item Number. Specifies the number of measure items that are appropriate for certain graph types, such as stock graphs. This is a parameter of the ROTATE_EVENT.

The literal value of MEASURE_ITEM_NUM is "bi_mn".

See Also:
RotateTool

MEASURE0

public static final java.lang.String MEASURE0
Thin-bean event parameter: Measure0. Specifies an index for the measure item that should be used as a first measure item by certain graph types. For example, for a high-low-close stock graph, this parameter indicates an index for the item used for 'High' stock prices. This is a parameter of the MEASURE_LAYOUT_EVENT.

The literal value of MEASURE0 is "bi_m0".

See Also:
RotateTool

MEASURE1

public static final java.lang.String MEASURE1
Thin-bean event parameter: Measure1. Specifies an index for the measure item that should be used as a second measure item by certain graph types. This is a parameter of the MEASURE_LAYOUT_EVENT.

The literal value of MEASURE1 is "bi_m1".

See Also:
RotateTool

MEASURE2

public static final java.lang.String MEASURE2
Thin-bean event parameter: Measure2. Specifies an index for the measure item that should be used as a third measure item by certain graph types. This is a parameter of the MEASURE_LAYOUT_EVENT.

The literal value of MEASURE2 is "bi_m2".

See Also:
RotateTool

MEASURE3

public static final java.lang.String MEASURE3
Thin-bean event parameter: Measure3. Specifies an index for the measure item that should be used as a fourth measure item by certain graph types. This is a parameter of the MEASURE_LAYOUT_EVENT.

The literal value of MEASURE3 is "bi_m3".

See Also:
RotateTool

MEASURE4

public static final java.lang.String MEASURE4
Thin-bean event parameter: Measure4. Specifies an index for the measure item that should be used as a fifth measure item by certain graph types. The fifth measure is used only as the volume measure in an open-high-low-close stock graph with volume. This is a parameter of the MEASURE_LAYOUT_EVENT.

The literal value of MEASURE4 is "bi_m4".

See Also:
RotateTool

EDGE

public static final java.lang.String EDGE
Thin-bean event parameter: Edge. Identifies an edge in the data source. This is a parameter of the DRILL_EVENT and of the HEADERDRILL_EVENT.

The literal value of EDGE is "bi_edge".

See Also:
ThinDataviewCommon, DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, DataDirector.PAGE_EDGE

LAYER

public static final java.lang.String LAYER
Thin-bean event parameter: Layer. Identifies a layer of an edge in the data source. This is a parameter of the DRILL_EVENT and of the HEADERDRILL_EVENT.

The literal value of LAYER is "bi_layer".

See Also:
ThinDataviewCommon

SLICE

public static final java.lang.String SLICE
Thin-bean event parameter: Slice. Identifies a slice of an edge in the data source. This is a parameter of the DRILL_EVENT and of the HEADERDRILL_EVENT.

The literal value of SLICE is "bi_slice".

See Also:
ThinDataviewCommon

FLAG

public static final java.lang.String FLAG
Thin-bean event parameter: Flag. This is a parameter of the DRILL_EVENT. This parameter identifies whether the drill event is a drill-expand operation or a drill-replace operation. The value for drill expand is "0" and the value for drill replace is DataDirector.DRILL_REPLACE or "1".

The literal value of FLAG is "bi_flag".

See Also:
ThinDataviewCommon, DataDirector.drill(int, int, int, int)

ROW

public static final java.lang.String ROW
Thin-bean event parameter: Row. Identifies a row in the databody of a thin crosstab or table. This is a parameter of the DATADRILL_EVENT.

The literal value of ROW is "bi_row".

See Also:
ThinDataviewCommon

COLUMN

public static final java.lang.String COLUMN
Thin-bean event parameter: Column. Identifies a column in the databody of a thin crosstab or table. This is a parameter of the DATADRILL_EVENT.

The literal value of COLUMN is "bi_col".

See Also:
ThinDataviewCommon

FULL_PATH_NAME

public static final java.lang.String FULL_PATH_NAME
Thin-bean event parameter: Full path name. Identifies an object in the BI Beans Catalog. This is a parameter of the following events:

The literal value of FULL_PATH_NAME is "bi_fpName".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch

OBJECT_TYPE

public static final java.lang.String OBJECT_TYPE
Thin-bean event parameter: Object type. Identifies the type of an object in the BI Beans Catalog. This is a parameter of the following events:

The literal value of OBJECT_TYPE is "bi_oType".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch, PersistableConstants

FILTER_TYPE

public static final java.lang.String FILTER_TYPE
Thin-bean event parameter: Filter type. Identifies the type of an object to display in an Explorer. This is a parameter of the FILTER_EVENT.

The literal value of FILTER_TYPE is "bi_fType".

See Also:
ExplorerTree, ExplorerDetail, ExplorerSearch

LOCATION

public static final java.lang.String LOCATION
Thin-bean event parameter: Location. Identifies the folder in which to save a thin presentation bean. This is a parameter of the SAVE_EVENT.

The literal value of LOCATION is "bi_loc".

See Also:
SaveAs

SEARCH_STRING

public static final java.lang.String SEARCH_STRING
Thin-bean event parameter: Search string. Identifies a string to search for in the BI Beans Catalog. This is a parameter of the SEARCH_EVENT.

The literal value of SEARCH_STRING is "bi_str".

See Also:
ExplorerTree, ExplorerSearch

SEARCH_CRITERION

public static final java.lang.String SEARCH_CRITERION
Thin-bean event parameter: Search criterion. Identifies what the SEARCH_STRING represents. This is a parameter of the SEARCH_EVENT. When the Search event is generated by the ExplorerTree, then the SEARCH_CRITERION is always object type.

The literal value of SEARCH_CRITERION is "bi_crt".

See Also:
ExplorerTree, ExplorerSearch

COLUMN_SORT_STATE

public static final java.lang.String COLUMN_SORT_STATE
Thin-bean event parameter: Sort state of a column. Identifies the sort state of the column before the sort event occurs. This is a parameter of the COLUMN_SORT_EVENT.

The literal value of COLUMN_SORT_STATE is "bi_colSortSt".


COLUMN_SORT_VALUE

public static final java.lang.String COLUMN_SORT_VALUE
Thin-bean event parameter: Column sort value. Identifies the value to be used for column sorting. This is a parameter of the COLUMN_SORT_EVENT.

The literal value of COLUMN_SORT_VALUE is "bi_colSortVal".

See Also:
COLUMN_SORT_EVENT

DIMENSION

public static final java.lang.String DIMENSION
Thin-bean event parameter: Dimension. Identifies the name of the dimension to which a favorite should be applied. This is a parameter of the APPLY_FAVORITE_EVENT.

The literal value of DIMENSION is "bi_dim".

See Also:
FavoriteTool

FAVORITE

public static final java.lang.String FAVORITE
Thin-bean event parameter: Favorite. Identifies a favorite set of dimension members to apply to the specified dimension. This is a parameter of the APPLY_FAVORITE_EVENT.

The literal value of FAVORITE is "bi_fav".

See Also:
FavoriteTool

SAVE_NAME

public static final java.lang.String SAVE_NAME
Thin-bean event parameter: Name to save under. Identifies the name to give a presentation bean that is being saved in the BI Beans Catalog. This is a parameter of the SAVE_EVENT.

The literal value of SAVE_NAME is "bi_sName".

See Also:
SaveAs

DESCRIPTION

public static final java.lang.String DESCRIPTION
Thin-bean event parameter: Description Identifies a description of a presentation bean that is being saved in the BI Beans Catalog. This is a parameter of the SAVE_EVENT.

The literal value of DESCRIPTION is "bi_desc".

See Also:
SaveAs

KEYWORDS

public static final java.lang.String KEYWORDS
Thin-bean event parameter: Keywords. Identifies search keywords to assign to a presentation bean that is being saved in the BI Beans Catalog. This is a parameter of the SAVE_EVENT.

The literal value of KEYWORDS is "bi_keys".

See Also:
SaveAs

SAVE_OVERWRITE

public static final java.lang.String SAVE_OVERWRITE
Thin-bean event parameter: Overwrite an existing item in the Catalog. Identifies whether to overwrite an existing presentation bean that has the same name in the same location, when you save a presentation bean to the BI Beans Catalog. This is a parameter of the SAVE_EVENT. This parameter can have one of the following values:

The literal value of SAVE_OVERWRITE is "bi_overwrite".

See Also:
SaveAs

SAVE_OVERWRITE_YES

public static final java.lang.String SAVE_OVERWRITE_YES
Thin-bean-event parameter value: Do overwrite an existing presentation bean. This parameter value also indicates that a Save Confirmation dialog should prompt for whether to overwrite an existing object in the Catalog.

This is a possible value of the SAVE_OVERWRITE parameter.

The literal value of SAVE_OVERWRITE_YES is "yes".

See Also:
SaveAs

SAVE_OVERWRITE_NO

public static final java.lang.String SAVE_OVERWRITE_NO
Thin-bean-event parameter value: Do not overwrite an existing presentation bean. This paramater value also indicates that a Save Confirmation dialog should prompt for whether to save a view, rather than prompting for whether to overwrite an existing object in the Catalog.

This is a possible value of the SAVE_OVERWRITE parameter.

The literal value of SAVE_OVERWRITE_NO is "no".

See Also:
SaveAs

TOOL

public static final java.lang.String TOOL
Thin-bean event parameter: Tool. Identifies the tool that is currently selected in the View Toolbar. This is a parameter of the SHOW_TOOL_EVENT.

The literal value of TOOL is "bi_tool".

See Also:
ViewToolbar

VIEW_TYPE

public static final java.lang.String VIEW_TYPE
Thin-bean event parameter: Type of view. Identifies the kind of thin presentation bean to display. This is a parameter of the VIEW_TYPE_CHANGED_EVENT.

The literal value of VIEW_TYPE is "bi_vt".

See Also:
ViewTypeTool

GRAPH_TYPE

public static final java.lang.String GRAPH_TYPE
Thin-bean event parameter: Graph type. When VIEW_TYPE is graph, then this parameter indicates the major graph type for the requested graph. For example, bar graphs are one type, and pie graphs are another type. This is a parameter of the VIEW_TYPE_CHANGED_EVENT.

The literal value of GRAPH_TYPE is "bi_gt".

See Also:
ViewTypeTool, GraphTypeConverter

GRAPH_SUBTYPE

public static final java.lang.String GRAPH_SUBTYPE
Thin-bean event parameter: Graph subtype. When VIEW_TYPE is graph, then this parameter indicates the subgraph for the requested graph. For example, a clustered bar graph is a graph subtype, as is a single pie graph. This is a parameter of the VIEW_TYPE_CHANGED_EVENT.

The literal value of GRAPH_SUBTYPE is "bi_gst".

See Also:
ViewTypeTool, GraphTypeConverter

SORT_DIMENSION

public static final java.lang.String SORT_DIMENSION
Thin-bean event parameter: Sort dimension. Identifies the dimension whose members should be sorted. This is a parameter of the SORT_EVENT. The sort dimension is identified by its edge and layer, in the format: edge*layer, where 'edge' and 'layer' are integer values.

The literal value of SORT_DIMENSION is "bi_sd".

See Also:
SortTool

SORT_CRITERION

public static final java.lang.String SORT_CRITERION
Thin-bean event parameter: Sort criterion. This is a parameter of the SORT_EVENT. This parameter can identify either of the following: