Package com.microstrategy.web.app.beans

Interface EnumSortEditorEvents

All Superinterfaces:

EnumPageEvents, EnumServletEvents

public interface EnumSortEditorEvents
extends EnumPageEvents

All event definitions used in sort editor bean

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields

Modifier and Type	Field	Description
static int	SORT_ORDER_ASCENDING
static int	SORT_ORDER_DESCENDING
static java.lang.String	SORT_PARAM_SEPARATOR
static int	WebEventArgumentActiveKey	Argument to specify the active key of the selectd view bean.
static int	WebEventArgumentCurrentTab
static int	WebEventArgumentGroupBySortCount	Indicate the number of Group By sorts included in the request
static int	WebEventArgumentGroupBySortKey	Argument to specify the sort key for Group By sorting in the Report Writer Sort Editor The sort key is made up of three different arguments.
static int	WebEventArgumentGroupBySortOrder	Indicate the Form SOrt Key of the Group By elements.
static int	WebEventArgumentRespectParent
static int	WebEventArgumentSortKey	Argument to specify the sort key for Sort Editor.
static int	WebEventArgumentSortOrder	Argument to specify the sort order.
static int	WebEventArgumentSortSubtotalPostion	Argument to specify the position of subtotals in sorted result.
static int	WebEventSortEditorProcess	Event to process the Sort Editor Form.
static int	WebEventSwitchEditorTab

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

WebEventSortEditorProcess

static final int WebEventSortEditorProcess

Event to process the Sort Editor Form.

See Also:

Constant Field Values

WebEventSwitchEditorTab

static final int WebEventSwitchEditorTab

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

WebEventArgumentSortKey

static final int WebEventArgumentSortKey

Argument to specify the sort key for Sort Editor.
This argument is made up of 5 different arguments and has a structure associated with it. These arguments are seperated by a seperator which is defined in EnumReportBeanEvents.SORT_PARAM_SEPARATOR. The sort key is different for sorting on rows and on columns. Based on what the user is sorting upon, some of these arguments within the sort key will be left blank.
Usage:
The sort key is made up of five different arguments.
Object Type - The first argument is the object type of the template unit on which the user wants to sort. Allowed values are specified in EnumDSSXMLObjectTypes Since we allow sorting only on metrics in the columns, the value of this argument for column sorting is always EnumDSSXMLObjectTypes.DssXmlTypeMetric
Object DSSID - The second argument is the DSS ID of the template unit on which the user wants to sort.
Form ID - The third argument is the Attribute Form ID of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting.
Form Type - The fourth argument is the Attribute Form Type of the template unit on which the user wants to sort. This argument is present only for row sorting and is blank for column sorting. Allowed values are specified in EnumDSSXMLObjectTypes.
Element List - The fifth argument is the list of elements included in the sort. This argument is present only for column sorting and is blank for row sorting. The list of elements is seperated by EnumReportBeanEvents.SORT_ELEM_LIST_SEPARATOR. This list of elements is used to identify the columns headers used in the sort.

See Also:

Constant Field Values

WebEventArgumentSortOrder

static final int WebEventArgumentSortOrder

Argument to specify the sort order.
The sort order can be ascending or descending. If the value of this argument is "TRUE" then the sort order is ascending. Any other value will denote a descending sort order.

See Also:

Constant Field Values

WebEventArgumentSortSubtotalPostion

static final int WebEventArgumentSortSubtotalPostion

Argument to specify the position of subtotals in sorted result.
The possible values are in EnumDSSXMLSubtotalsPosition. Default is com.microstrategy.webapi.EnumDSSXMLSubtotalsPosition.DssSubtotalsPositionInherit.

See Also:

Constant Field Values

WebEventArgumentActiveKey

static final int WebEventArgumentActiveKey

Argument to specify the active key of the selectd view bean.

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

WebEventArgumentGroupBySortKey

static final int WebEventArgumentGroupBySortKey

Argument to specify the sort key for Group By sorting in the Report Writer Sort Editor The sort key is made up of three different arguments.
Section Key - Indicates the Section ID wehre the attribute is present
Form ID - The second argument is the Attribute Form ID of the template unit on which the user wants to sort.
Sort Order - Indicates the sort order (0. Descending | 1. Ascending)

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

WebEventArgumentGroupBySortCount

static final int WebEventArgumentGroupBySortCount

Indicate the number of Group By sorts included in the request

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

WebEventArgumentGroupBySortOrder

static final int WebEventArgumentGroupBySortOrder

Indicate the Form SOrt Key of the Group By elements.

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

WebEventArgumentCurrentTab

static final int WebEventArgumentCurrentTab

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

WebEventArgumentRespectParent

static final int WebEventArgumentRespectParent

See Also:

Constant Field Values

SORT_PARAM_SEPARATOR

static final java.lang.String SORT_PARAM_SEPARATOR

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

SORT_ORDER_ASCENDING

static final int SORT_ORDER_ASCENDING

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values

SORT_ORDER_DESCENDING

static final int SORT_ORDER_DESCENDING

Since:

MicroStrategy Web 8.0.0

See Also:

Constant Field Values