public interface

EnumObjectBrowserBeanEvents

implements EnumPageEvents
com.microstrategy.web.app.beans.EnumObjectBrowserBeanEvents

Class Overview

This enumeration contains the list of events and arguments handled by the ObjectBrowserBean.

Summary

Constants
int WebEventArgumentAddElement Identifier for the argument that indicates an element shown on the object browser will be added to the grid.
int WebEventArgumentBrowserObjectID Identifier for the argument that indicates the object ID of the folder to browse.
int WebEventArgumentBrowserPage Identifier for the argument that indicates the page where the user should be taken as part of the incremental fetch request.
int WebEventArgumentBrowserSearchString Identifier for the argument that indicates the string the user requests to search.
int WebEventArgumentBrowserTab Identifier for the argument that indicates the tab the user requested to be shown.
int WebEventArgumentGoToParent Identifier for the argument that indicates the user wants to browse the parent folder of the current folder being viewed.
int WebEventArgumentObjectInfo Identifier for the argument that indicates the information of the element to be added or removed.
int WebEventArgumentParentFolderID Identifier for the argument that indicates the object ID of the parent folder to browse.
int WebEventArgumentRemoveElement Identifier for the argument that indicates an element shown on the object browser will be removed.
int WebEventBrowserGotoPage Identifier for the event that allows users to navigate the different pages of the Object Browser (incremental fetch).
int WebEventBrowserModifyGrid Identifier for the event that allows users to modify the contents on the grid given the objects shown on the Object Browser.
int WebEventBrowserNavigate Identifier for the event that allows users to display the contents of a specific folder.
int WebEventBrowserSearch Identifier for the event that allows users to run searches based on a given string.
int WebEventBrowserSelectTab Identifier for the event that allows users to switch the tab currently displayed on the Object Browser.
[Expand]
Inherited Constants
From interface com.microstrategy.web.app.beans.EnumPageEvents
From interface com.microstrategy.web.app.beans.EnumServletEvents

Constants

public static final int WebEventArgumentAddElement

Identifier for the argument that indicates an element shown on the object browser will be added to the grid. Usage:
Any value can be assigned to this argument. If it has a value, then its action will take effect. It should be used together with the WebEventArgumentObjectInfo argument.

Constant Value: 27008 (0x00006980)

public static final int WebEventArgumentBrowserObjectID

Identifier for the argument that indicates the object ID of the folder to browse. The object ID value specified for this argument should be a valid one, existing in the current project's metadata.

Constant Value: 27002 (0x0000697a)

public static final int WebEventArgumentBrowserPage

Identifier for the argument that indicates the page where the user should be taken as part of the incremental fetch request. The page value specified for this argument should be a valid one, depending on the number of results of the last browse or search request.

Constant Value: 27003 (0x0000697b)

public static final int WebEventArgumentBrowserSearchString

Identifier for the argument that indicates the string the user requests to search.

Constant Value: 27004 (0x0000697c)

public static final int WebEventArgumentBrowserTab

Identifier for the argument that indicates the tab the user requested to be shown. Usage:
Possible values for this argument include those listed on the EnumObjectBrowserTabs enumeration, such as ObjectBrowserReportObjectsTab, ObjectBrowserAllObjectsTab, etc.

Constant Value: 27001 (0x00006979)

public static final int WebEventArgumentGoToParent

Identifier for the argument that indicates the user wants to browse the parent folder of the current folder being viewed. Usage:
Any value can be assigned to this argument. If it has a value, then its action will take effect. It should be used together with the WebEventArgumentGoToParent argument.

Constant Value: 27006 (0x0000697e)

public static final int WebEventArgumentObjectInfo

Identifier for the argument that indicates the information of the element to be added or removed. Usage:
The value assigned to this argument will be a string that holds the detailed information of the object to be used on the event. Each one of the fields listed will be separated by an ITEM_SEPARATOR. and they should be added in the following order: ObjectIDITEM_SEPARATORObjectTypeITEM_SEPARATORObjectSubtypeITEM_SEPARATORObjectAliasITEM_SEPARATORObjectName

Constant Value: 27010 (0x00006982)

public static final int WebEventArgumentParentFolderID

Identifier for the argument that indicates the object ID of the parent folder to browse. Usage:
The object ID value specified for this argument should be a valid folder ID string, existing in the current project's metadata, parent of the folder currently being viewed. This argument is to be used together with the WebEventArgumentGoToParent for accessing the parent folder's content.

Constant Value: 27005 (0x0000697d)

public static final int WebEventArgumentRemoveElement

Identifier for the argument that indicates an element shown on the object browser will be removed. Usage:
Any value can be assigned to this argument. If it has a value, then its action will take effect. It should be used together with the WebEventArgumentObjectInfo argument.

Constant Value: 27009 (0x00006981)

public static final int WebEventBrowserGotoPage

Identifier for the event that allows users to navigate the different pages of the Object Browser (incremental fetch).

Constant Value: 27003 (0x0000697b)

public static final int WebEventBrowserModifyGrid

Identifier for the event that allows users to modify the contents on the grid given the objects shown on the Object Browser.

Constant Value: 27005 (0x0000697d)

public static final int WebEventBrowserNavigate

Identifier for the event that allows users to display the contents of a specific folder.

Constant Value: 27002 (0x0000697a)

public static final int WebEventBrowserSearch

Identifier for the event that allows users to run searches based on a given string.

Constant Value: 27004 (0x0000697c)

public static final int WebEventBrowserSelectTab

Identifier for the event that allows users to switch the tab currently displayed on the Object Browser.

Constant Value: 27001 (0x00006979)