Package com.microstrategy.web.app.beans

Interface EnumPageByBeanEvents

All Superinterfaces:

EnumPageEvents, EnumServletEvents

public interface EnumPageByBeanEvents
extends EnumPageEvents

Defines the events and arguments available for the PageByBean.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	ACTION_ADD
static int	ACTION_DELETE
static java.lang.String	ACTION_DELIMITER
static int	ACTION_NONE
static int	ACTION_PIVOT
static int	ACTION_REMOVE
static int	ACTION_SELECT
static int	ACTION_SORT
static int	DISPLAY_TYPE_CUSTOM
static int	DISPLAY_TYPE_DEFAULT
static java.lang.String	METRICS_UNIT_ID
static java.lang.String	PIVOT_LEFT
static java.lang.String	PIVOT_RIGHT
static java.lang.String	PIVOT_TO_COLUMNS
static java.lang.String	PIVOT_TO_ROWS
static int	SORT_ORDER_ASCENDING
static int	SORT_ORDER_DEFAULT
static int	SORT_ORDER_DESCENDING
static int	WebEventArgumentPageByAction	Argument that specifies an action to apply in the Generic Event.
static int	WebEventArgumentPageByApply	Argument that specifies the name of the apply button.
static int	WebEventArgumentPageByAutosubmit	Argument that specifies the that the selection was done using auto-submit.
static int	WebEventArgumentPageByDatasetID	Argument that specifies the datasetID of the dataset from which the page by element is being added from.
static int	WebEventArgumentPageByDisplayAttrForms	Argument that specifies the Disyplay attribute forms of the groupBy unit.
static int	WebEventArgumentPageByDisplayType	Argument that specifies the DisyplayType of the groupBy unit.
static int	WebEventArgumentPageByObjectID	Argument that specifies the ID of an object to add as a page-by unit.
static int	WebEventArgumentPageByObjectSubtype	Argument that specifies the DSSSubType of an object to add as a page-by unit.
static int	WebEventArgumentPageByObjectType	Argument that specifies the DSSType of an object to add as a page-by unit.
static int	WebEventArgumentPageByPivotAction	Argument that specifies what the pivot action should be.
static int	WebEventArgumentPageBySelectedElement	Argument that specifies the current page-by selection.
static int	WebEventArgumentPageBySortOrder	Argument that specifies an action to apply in the Generic Event.
static int	WebEventArgumentPageByUnitDestinationAxis	Argument that specifies the destination's axis: WebEventPageByPivot
static int	WebEventArgumentPageByUnitDestinationKey	Argument that specifies the destination's unit key: WebEventPageByPivot
static int	WebEventArgumentPageByUnitKey	Argument that specifies the current unit key: WebEventPageByPivot WebEventPageBySort
static int	WebEventPageByAdd	Event to add an element into the PageBy.
static int	WebEventPageByDelete	Event to delete a PageBy unit from the report definition.
static int	WebEventPageByDisplayAttrForms	Event to select attribute forms to display in a GroupBy Unit.
static int	WebEventPageByDisplayType	Event to select display type in a GroupBy Unit.
static int	WebEventPageByGeneric	Generic Event for Page-by.
static int	WebEventPageByPivot	Event to pivot a PageBy Unit.
static int	WebEventPageByRemove	Event to remove an element from the PageBy section.
static int	WebEventPageBySelectElement	Event to select an element in a PageBy Unit.
static int	WebEventPageBySort	Event that toggles the sort a PageBy Unit.

Fields inherited from interface com.microstrategy.web.app.beans.EnumPageEvents

WebEventArgumentAddUnitButton, WebEventArgumentAnswerFormat, WebEventArgumentAnswerOptions, WebEventArgumentAttributeIdFormId, WebEventArgumentBean, WebEventArgumentBoneHeight, WebEventArgumentBoneName, WebEventArgumentBoneWidth, WebEventArgumentBrowserSettingName, WebEventArgumentBrowserSettingValue, WebEventArgumentClearExistinAndAddUnitsButton, WebEventArgumentExecutePromptedReport, WebEventArgumentFolderViewMode, WebEventArgumentLoadFile, WebEventArgumentLoadFileSeparator, WebEventArgumentNCSubscriptionsViewMode, WebEventArgumentPrefName, WebEventArgumentPrefValue, WebEventArgumentPromptFunction, WebEventArgumentRefreshOrigin, WebEventArgumentSaveFolderID, WebEventArgumentScreenMode, WebEventArgumentSecurityRolesViewMode, WebEventArgumentShowBean, WebEventArgumentShowBeanProperties, WebEventArgumentSubscriptionsViewMode, WebEventArgumentTextFileAnswer, WebEventArgumentUnitsToAdd, WebEventArgumentUserManagerViewModeType, WebEventChangeFolderViewMode, WebEventChangeSecurityRolesViewMode, WebEventChangeSubscriptionsViewMode, WebEventChangeUserManagerViewModeType, WebEventRefresh, WebEventSetPermanentBrowserSetting, WebEventSetSaveFolderID, WebEventSetSessionBrowserSetting, WebEventShowBean, WebEventSwitchScreenMode, WebEventUpdateBoneProperty, WebEventUpdatePreference

Fields inherited from interface com.microstrategy.web.app.beans.EnumServletEvents

RWebEventArgumentIMPORTAFTERSAVE, WebEventAddCacheSubscription, WebEventAddInboxSubscription, WebEventAddMobileSubscription, WebEventAddPersonalViewSubscription, WebEventAddSubscription, WebEventAdminOpenHome, WebEventArgumentActionType, WebEventArgumentAdvancedOption, WebEventArgumentAllowExecute, WebEventArgumentAnalysisAddMode, WebEventArgumentAnalysisID, WebEventArgumentApplyChangesFirst, WebEventArgumentAuthenticationMode, WebEventArgumentBeansState, WebEventArgumentCheckLogin, WebEventArgumentClearPage, WebEventArgumentConvertDashboardToDoc, WebEventArgumentCubeName, WebEventArgumentCubeReportId, WebEventArgumentDocumentID, WebEventArgumentDocumentViewMode, WebEventArgumentDrillDisplayMode, WebEventArgumentDrillElementList, WebEventArgumentDrillFilterOnPageBy, WebEventArgumentDrillGraphPixelX, WebEventArgumentDrillGraphPixelY, WebEventArgumentDrillPathKey, WebEventArgumentDrillRetainParent, WebEventArgumentDrillRetainThreshold, WebEventArgumentErrorCode, WebEventArgumentEventToForwardTo, WebEventArgumentExportDefaultRunMode, WebEventArgumentExportExpandPageByFields, WebEventArgumentexportFilterDetails, WebEventArgumentExportFormatNameGraphs, WebEventArgumentExportFormatNameGrids, WebEventArgumentExportFromOptions, WebEventArgumentExportHeadersAsText, WebEventArgumentExportMetricValuesAsText, WebEventArgumentExportOfficeRefresh, WebEventArgumentExportOverlapGridTitles, WebEventArgumentExportSection, WebEventArgumentExportTextDelimiter, WebEventArgumentExportUseLiveChartGraphs, WebEventArgumentExportUseSeparateSheets, WebEventArgumentFacebookToken, WebEventArgumentFastExportLink, WebEventArgumentFolderId, WebEventArgumentFolderName, WebEventArgumentFolderType, WebEventArgumentFromPageHistory, WebEventArgumentGraphHeight, WebEventArgumentGraphRequestId, WebEventArgumentGraphShrinkHeight, WebEventArgumentGraphShrinkWidth, WebEventArgumentGraphWidth, WebEventArgumentIgnoreGraphHeightWidth, WebEventArgumentIsAdminHelp, WebEventArgumentIsContinueForm, WebEventArgumentIsCubeEdit, WebEventArgumentIsCubeRepublish, WebEventArgumentIsFFSQL, WebEventArgumentIsFromPrompt, WebEventArgumentIsNew, WebEventArgumentIsNewAnalysis, WebEventArgumentLoginMode, WebEventArgumentMenuID, WebEventArgumentMenuOptionID, WebEventArgumentMessage, WebEventArgumentMessageID, WebEventArgumentNodeKey, WebEventArgumentNotAskExportOptions, WebEventArgumentObjectID, WebEventArgumentObjectType, WebEventArgumentParentFolderId, WebEventArgumentPDFAdminFooterFile, WebEventArgumentPDFAdminHeaderFile, WebEventArgumentPDFCoverPageFilterDetails, WebEventArgumentPDFExpandPageByFields, WebEventArgumentPDFExportFilename, WebEventArgumentPDFExportSection, WebEventArgumentPDFFitToPagesTall, WebEventArgumentPDFFitToPagesWide, WebEventArgumentPDFFooterCenterSection, WebEventArgumentPDFFooterLeftSection, WebEventArgumentPDFFooterRightSection, WebEventArgumentPDFHeaderCenterSection, WebEventArgumentPDFHeaderLeftSection, WebEventArgumentPDFHeaderRightSection, WebEventArgumentPDFMarginSizeBottom, WebEventArgumentPDFMarginSizeLeft, WebEventArgumentPDFMarginSizeRight, WebEventArgumentPDFMarginSizeTop, WebEventArgumentPDFMaxCells, WebEventArgumentPDFMaxFooterSize, WebEventArgumentPDFMaxHeaderSize, WebEventArgumentPDFOutlineModeState, WebEventArgumentPDFPaperOrientationOption, WebEventArgumentPDFPaperSize, WebEventArgumentPDFScalingOption, WebEventArgumentPDFShowOptions, WebEventArgumentPDFShrinkFontPercentage, WebEventArgumentPortNumber, WebEventArgumentPreferenceGroup, WebEventArgumentPreferenceGroupSet, WebEventArgumentPreferenceTransform, WebEventArgumentPrintAdminFooterFile, WebEventArgumentPrintAdminHeaderFile, WebEventArgumentPrintCoverPageFilterDetails, WebEventArgumentPrintDefaultColsPerPage, WebEventArgumentPrintDefaultRowsPerPage, WebEventArgumentPrintDisplayPopupPrintDialog, WebEventArgumentPrintExpandPagebyFields, WebEventArgumentPrintFitColsToPage, WebEventArgumentPrintFitRowsToPage, WebEventArgumentPrintFooterCenterSection, WebEventArgumentPrintFooterLeftSection, WebEventArgumentPrintFooterRightSection, WebEventArgumentPrintGridColsPerPage, WebEventArgumentPrintGridGraphSamePage, WebEventArgumentPrintGridRowsPerPage, WebEventArgumentPrintHeaderCenterSection, WebEventArgumentPrintHeaderLeftSection, WebEventArgumentPrintHeaderRightSection, WebEventArgumentPrintMarginSizeBottom, WebEventArgumentPrintMarginSizeLeft, WebEventArgumentPrintMarginSizeRight, WebEventArgumentPrintMarginSizeTop, WebEventArgumentPrintMaxCellsPerBlock, WebEventArgumentPrintMaxColsPerPage, WebEventArgumentPrintMaxFooterSize, WebEventArgumentPrintMaxGraphsPerBlock, WebEventArgumentPrintMaxHeaderSize, WebEventArgumentPrintMaxRowsPerPage, WebEventArgumentPrintOpenNewWindow, WebEventArgumentPrintPaperOrientationOption, WebEventArgumentPrintPaperSize, WebEventArgumentPrintScalingOption, WebEventArgumentPrintShowOptionsOnPrint, WebEventArgumentPrintShrinkFontPercentage, WebEventArgumentProjectName, WebEventArgumentPromptExpressionType, WebEventArgumentPromptStyle, WebEventArgumentQueryBuild, WebEventArgumentRelativePageNumber, WebEventArgumentReportDesignMode, WebEventArgumentReportFilterID, WebEventArgumentReportParentFolderID, WebEventArgumentReportStateID, WebEventArgumentReportTemplateID, WebEventArgumentReportViewMode, WebEventArgumentRWCreationFlags, WebEventArgumentRWCreationTemplateID, WebEventArgumentRWExecutionMode, WebEventArgumentRWExportMode, WebEventArgumentRWPageByElements, WebEventArgumentRWViewMode, WebEventArgumentSaveAsOrigin, WebEventArgumentSaveAsOriginPath, WebEventArgumentSaveAsShowContinueButton, WebEventArgumentScheduleEditMode, WebEventArgumentSearchDomain, WebEventArgumentSearchString, WebEventArgumentServerAlias, WebEventArgumentServerName, WebEventArgumentSessionKey, WebEventArgumentShow, WebEventArgumentShowDefault, WebEventArgumentShowOptionsPage, WebEventArgumentShowServerProperties, WebEventArgumentSliceId, WebEventArgumentSourceId, WebEventArgumentSourceType, WebEventArgumentSubPage, WebEventArgumentSubscriptionDeliveryMode, WebEventArgumentSubscriptionID, WebEventArgumentTarget, WebEventArgumentTreeType, WebEventArgumentTriggerID, WebEventArgumentTwoStepVerificationCode, WebEventArgumentUpdateParentWindow, WebEventArgumentUserId, WebEventArgumentUserName, WebEventArgumentUserPassword, WebEventCallChangePassword, WebEventCancel, WebEventCloseDashboardPage, WebEventCreateBlankVI, WebEventCreateHTML5VI, WebEventCreateOptimizedVI, WebEventCreatePrompt, WebEventCreateSecurityRole, WebEventCreateUser, WebEventCreateUserGroup, WebEventDashboardPublishWizard, WebEventDeleteHistoryList, WebEventDeleteObject, WebEventDisplayError, WebEventDrillToFixedTemplateFromDocToReport, WebEventEditCacheSubscription, WebEventEditInboxSubscription, WebEventEditMobileSubscription, WebEventEditPersonalViewSubscription, WebEventEditPrompt, WebEventEditReport, WebEventEditRW, WebEventEditSecurityRole, WebEventEditSubscription, WebEventEditUser, WebEventEditUserGroup, WebEventExecuteHTML5VI, WebEventExecuteMojoIVE, WebEventExecuteRWDocumentHeavy, WebEventExportSaveReportProperties, WebEventFastDocumentExport, WebEventFastExport, WebEventFastPDFExport, WebEventForwardToRWExport, WebEventGeneric, WebEventGetDocumentDetails, WebEventGetReportDetails, WebEventGetRWDocumentDetails, WebEventGraphDrillFromDocToReport, WebEventGridDrillFromDocToReport, WebEventHTMLMenu, WebEventInitializeHTML5VIFromSubscription, WebEventIPadAnnotation, WebEventLoadGraph, WebEventLogout, WebEventNCAddFileSubscription, WebEventNCAddFTPSubscription, WebEventNCAddPrintSubscription, WebEventNCAddresses, WebEventNCAddSubscription, WebEventNCEditFileSubscription, WebEventNCEditFTPSubscription, WebEventNCEditPrintSubscription, WebEventNCEditSubscription, WebEventNCFileAddresses, WebEventNCFTPAddresses, WebEventNCOpenDeleteAddress, WebEventNCPrintAddresses, WebEventNCSendNow, WebEventNCSendNowConfirm, WebEventNCSubsConfirm, WebEventOpenAbout, WebEventOpenAdminFAQs, WebEventOpenAdminHelp, WebEventOpenAdminHelpIndex, WebEventOpenCreate, WebEventOpenCreateDocument, WebEventOpenCreatePromptPage, WebEventOpenDefaultDesktop, WebEventOpenDefaultHomePage, WebEventOpenDesktop, WebEventOpenDiagnostics, WebEventOpenExport, WebEventOpenExportDocument, WebEventOpenExportOptions, WebEventOpenExportOptionsFromReport, WebEventOpenFAQs, WebEventOpenFilterEditor, WebEventOpenHelp, WebEventOpenHelpIndex, WebEventOpenHelpSetup, WebEventOpenHistoryList, WebEventOpenHistoryPage, WebEventOpenHome, WebEventOpenImportWizard, WebEventOpenImportWizardEntryPage, WebEventOpenIPAConfiguration, WebEventOpenIPAMonitor, WebEventOpenMyPage, WebEventOpenMyReports, WebEventOpenMySubscriptions, WebEventOpenObjectSubscriptions, WebEventOpenOfficeSetup, WebEventOpenOptimizedVI, WebEventOpenPage, WebEventOpenPDFOptions, WebEventOpenPDFOptionsFromReport, WebEventOpenPDFSaveReportProperties, WebEventOpenPreferences, WebEventOpenPrint, WebEventOpenPrintDocument, WebEventOpenPrintOptions, WebEventOpenPrintOptionsFromReport, WebEventOpenPrintSaveReportProperties, WebEventOpenQBuilder, WebEventOpenRRAccountSetting, WebEventOpenRRQuoteAcceptanceForm, WebEventopenRRUserImport, WebEventOpenRRUserManagement, WebEventOpenSaveReportProperties, WebEventOpenSchedule, WebEventOpenSearch, WebEventOpenSecurityRolesFolder, WebEventOpenSecuritySetup, WebEventOpenSharedReports, WebEventOpenSubscriptionEngineSetup, WebEventOpenSummary, WebEventOpenTopLevelUserGroups, WebEventOpenWizard, WebEventPDFDisplay, WebEventPrefColorPalette, WebEventPrefDynamicAddresseList, WebEventProcessLogin, WebEventQuickLogout, WebEventReportFlashExport, WebEventReportWritingDocumentPDFExport, WebEventReportWritingDocumentPDFFastExport, WebEventReturnTo, WebEventRunSearch, WebEventRWDHTMLExport, WebEventRWExport, WebEventRWSaveAs, WebEventSaveAs, WebEventSelectFilter, WebEventSelectTemplate, WebEventTakeMeHome, WebOpenAnalysis, WebOpenPrefChangePwdPage

Field Detail

WebEventPageByPivot

static final int WebEventPageByPivot

Event to pivot a PageBy Unit.

See Also:

Constant Field Values

WebEventPageBySort

static final int WebEventPageBySort

Event that toggles the sort a PageBy Unit.

See Also:

Constant Field Values

WebEventPageBySelectElement

static final int WebEventPageBySelectElement

Event to select an element in a PageBy Unit.

See Also:

Constant Field Values

WebEventPageByRemove

static final int WebEventPageByRemove

Event to remove an element from the PageBy section.

See Also:

Constant Field Values

WebEventPageByAdd

static final int WebEventPageByAdd

Event to add an element into the PageBy.

See Also:

Constant Field Values

WebEventPageByGeneric

static final int WebEventPageByGeneric

Generic Event for Page-by. This event is designed to support all the page-by actions. The action to perform is sent as an argument. More over, if the name of the argument ends with ".x" it assumes the value is coming from an IMG INPUT and reads the values directly from the argument name; all of this is intended to support HTML mode and its usage is not recommended.

See Also:

Constant Field Values

WebEventPageByDelete

static final int WebEventPageByDelete

Event to delete a PageBy unit from the report definition.

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

WebEventPageByDisplayType

static final int WebEventPageByDisplayType

Event to select display type in a GroupBy Unit.

See Also:

Constant Field Values

WebEventPageByDisplayAttrForms

static final int WebEventPageByDisplayAttrForms

Event to select attribute forms to display in a GroupBy Unit.

See Also:

Constant Field Values

WebEventArgumentPageByUnitKey

static final int WebEventArgumentPageByUnitKey

Argument that specifies the current unit key:

WebEventPageByPivot
WebEventPageBySort

See Also:

Constant Field Values

WebEventArgumentPageByUnitDestinationKey

static final int WebEventArgumentPageByUnitDestinationKey

Argument that specifies the destination's unit key:

WebEventPageByPivot

See Also:

Constant Field Values

WebEventArgumentPageByUnitDestinationAxis

static final int WebEventArgumentPageByUnitDestinationAxis

Argument that specifies the destination's axis:

WebEventPageByPivot

See Also:

Constant Field Values

WebEventArgumentPageByPivotAction

static final int WebEventArgumentPageByPivotAction

Argument that specifies what the pivot action should be. This can be used to specify whether to move a unit left/right/to rows/to columns instead of specifying the targeted position/axis.

WebEventPageByPivot

See Also:

Constant Field Values

WebEventArgumentPageBySelectedElement

static final int WebEventArgumentPageBySelectedElement

Argument that specifies the current page-by selection. The format of the value is a list of one or more position + elementID pairs. unitKeyEnumReportBeanEvents.PAGE_BY_KEY_SEPARATORelementID

WebEventPageBySelectElement

See Also:

Constant Field Values

WebEventArgumentPageByAutosubmit

static final int WebEventArgumentPageByAutosubmit

Argument that specifies the that the selection was done using auto-submit. It will be true if the value is "1". False otherwise.

WebEventPageBySelectElement

See Also:

Constant Field Values

WebEventArgumentPageByObjectID

static final int WebEventArgumentPageByObjectID

Argument that specifies the ID of an object to add as a page-by unit.

WebEventPageByAdd

See Also:

Constant Field Values

WebEventArgumentPageByObjectType

static final int WebEventArgumentPageByObjectType

Argument that specifies the DSSType of an object to add as a page-by unit.

WebEventPageByAdd

See Also:

Constant Field Values

WebEventArgumentPageByApply

static final int WebEventArgumentPageByApply

Argument that specifies the name of the apply button.

WebEventPageBySelectElement

See Also:

Constant Field Values

WebEventArgumentPageByAction

static final int WebEventArgumentPageByAction

Argument that specifies an action to apply in the Generic Event.

WebEventPageByGeneric

See Also:

Constant Field Values

WebEventArgumentPageBySortOrder

static final int WebEventArgumentPageBySortOrder

Argument that specifies an action to apply in the Generic Event.

WebEventPageByGeneric

See Also:

Constant Field Values

WebEventArgumentPageByObjectSubtype

static final int WebEventArgumentPageByObjectSubtype

Argument that specifies the DSSSubType of an object to add as a page-by unit.

WebEventPageByAdd

See Also:

Constant Field Values

WebEventArgumentPageByDatasetID

static final int WebEventArgumentPageByDatasetID

Argument that specifies the datasetID of the dataset from which the page by element is being added from.

WebEventPageByAdd

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

WebEventArgumentPageByDisplayType

static final int WebEventArgumentPageByDisplayType

Argument that specifies the DisyplayType of the groupBy unit.

WebEventPageByDisplayType

See Also:

Constant Field Values

WebEventArgumentPageByDisplayAttrForms

static final int WebEventArgumentPageByDisplayAttrForms

Argument that specifies the Disyplay attribute forms of the groupBy unit.

WebEventPageByDisplayType

See Also:

Constant Field Values

PIVOT_LEFT

static final java.lang.String PIVOT_LEFT

See Also:

Constant Field Values

PIVOT_RIGHT

static final java.lang.String PIVOT_RIGHT

See Also:

Constant Field Values

PIVOT_TO_ROWS

static final java.lang.String PIVOT_TO_ROWS

See Also:

Constant Field Values

PIVOT_TO_COLUMNS

static final java.lang.String PIVOT_TO_COLUMNS

See Also:

Constant Field Values

ACTION_NONE

static final int ACTION_NONE

See Also:

Constant Field Values

ACTION_PIVOT

static final int ACTION_PIVOT

See Also:

Constant Field Values

ACTION_SORT

static final int ACTION_SORT

See Also:

Constant Field Values

ACTION_SELECT

static final int ACTION_SELECT

See Also:

Constant Field Values

ACTION_REMOVE

static final int ACTION_REMOVE

See Also:

Constant Field Values

ACTION_ADD

static final int ACTION_ADD

See Also:

Constant Field Values

ACTION_DELETE

static final int ACTION_DELETE

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

SORT_ORDER_DEFAULT

static final int SORT_ORDER_DEFAULT

See Also:

Constant Field Values

SORT_ORDER_ASCENDING

static final int SORT_ORDER_ASCENDING

See Also:

Constant Field Values

SORT_ORDER_DESCENDING

static final int SORT_ORDER_DESCENDING

See Also:

Constant Field Values

ACTION_DELIMITER

static final java.lang.String ACTION_DELIMITER

See Also:

Constant Field Values

METRICS_UNIT_ID

static final java.lang.String METRICS_UNIT_ID

Since:

MicroStrategy Web 8.0.1

See Also:

Constant Field Values

DISPLAY_TYPE_DEFAULT

static final int DISPLAY_TYPE_DEFAULT

See Also:

Constant Field Values

DISPLAY_TYPE_CUSTOM

static final int DISPLAY_TYPE_CUSTOM

See Also:

Constant Field Values