Package com.microstrategy.web.app.beans

Class ReportPageEventHandler

java.lang.Object

com.microstrategy.web.beans.GenericEventHandler

com.microstrategy.web.beans.AggregatedEventHandler

com.microstrategy.web.app.beans.ReportPageEventHandler

All Implemented Interfaces:

EnumPageEvents, EnumServletEvents, WebEventHandler, WebEventTags, java.lang.Cloneable

public class ReportPageEventHandler
extends AggregatedEventHandler
implements EnumPageEvents

Default event handler for Page object in the Microstrategy Web.

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.web.beans.GenericEventHandler

GenericEventHandler.GenericEventKeys

Field Summary

Fields inherited from class com.microstrategy.web.beans.AggregatedEventHandler

defaultHandler

Fields inherited from class com.microstrategy.web.beans.GenericEventHandler

_extraEvents, layerOfHandleRequest, MULTIPLE_EVENT_SOURCE_SUFFIX, NO_EVENT_ID

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

Fields inherited from interface com.microstrategy.web.beans.WebEventTags

ATT_ARGUMENT_ENUMERATOR, ATT_ARGUMENT_ID, ATT_ARGUMENT_INDEX, ATT_ARGUMENT_NAME, ATT_ARGUMENT_REQUIRED, ATT_ARGUMENT_TYPE, ATT_ARGUMENT_VALIDATOR, ATT_ARGUMENT_VALUE, ATT_EVENT_DEPRECATED, ATT_EVENT_ENUMERATOR, ATT_EVENT_HANDLER_ENUMERATOR, ATT_EVENT_HANDLER_NAME, ATT_EVENT_HANDLER_TYPE, ATT_EVENT_ID, ATT_EVENT_NAME, ATT_EVENT_TARGET, TAG_ARGUMENT, TAG_ARGUMENTS, TAG_EVENT, TAG_EVENT_HANDLER, TAG_EVENT_HANDLERS, TAG_EVENTS

Constructor Summary

Constructors

Constructor	Description
ReportPageEventHandler()

Method Summary

Modifier and Type	Method	Description
protected boolean	handleDefaultRequest(RequestKeys keys)	Asks the default event handler to handle the request.
boolean	handleRequest(RequestKeys keys)	Handles the WebEvent specified in the RequestKeys object.
boolean	processRequest(RequestKeys keys)	This method encapsulates the logic to process an incoming event.

Methods inherited from class com.microstrategy.web.beans.AggregatedEventHandler

defaultDelegate, delegateRequest, getDefaultHandler, getHandlerType, getSupportedWebComponentType, getWebEvent, setDefaultHandler, setHandlerType

Methods inherited from class com.microstrategy.web.beans.GenericEventHandler

addEvent, addEvent, addEvents, addEventsFromRequestKeys, addEventsFromXML, appendRemainingEvent, clone, getEventID, getEventTarget, getName, getNextSourceName, getNextSourceName, getOrderedEvents, getPendingEvents, getWebComponent, getWebEvent, getWebEvent, getWebEvents, getWebEventsFromRequest, isInitialized, isMyEvent, markInitailized, processExtraEvents, processMultipleEvents, processMultipleEvents, setName, setWebComponent, validateRequiredArgument

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportPageEventHandler

public ReportPageEventHandler()

Method Detail

handleRequest

public boolean handleRequest(RequestKeys keys)
                      throws WebException

Description copied from class: GenericEventHandler

Handles the WebEvent specified in the RequestKeys object. By default, this method will invoke GenericEventHandler.processRequest(RequestKeys) followed by GenericEventHandler.delegateRequest(RequestKeys).

Specified by:

handleRequest in interface WebEventHandler

Overrides:

handleRequest in class GenericEventHandler

Parameters:

keys - the RequestKeys object containing event ID, sources, and any other information.

Returns:

true if handling succeeds; false if the event is ignored and not handled.

Throws:

WebException - thrown if handling of the request fails.

handleDefaultRequest

protected boolean handleDefaultRequest(RequestKeys keys)
                                throws WebException

Description copied from class: AggregatedEventHandler

Asks the default event handler to handle the request.

Overrides:

handleDefaultRequest in class AggregatedEventHandler

Parameters:

keys - the RequestKeys object containing event ID, sources, and any other information.

Returns:

true if handling succeeds; false if the event is ignored and not handled.

Throws:

WebException

processRequest

public boolean processRequest(RequestKeys keys)
                       throws WebException

Description copied from class: AggregatedEventHandler

This method encapsulates the logic to process an incoming event. Normally, this is invoked by GenericEventHandler.handleRequest(RequestKeys).

Specified by:

processRequest in interface WebEventHandler

Specified by:

processRequest in class AggregatedEventHandler

Parameters:

keys - the RequestKeys object containing event ID, sources, and any other information.

Returns:

true if handling succeeds; false if the event is ignored and not handled.

Throws:

WebException - thrown if handling of the request fails.