Package com.microstrategy.web.app.beans

Interface FilterEditorBean

    • Field Detail

      • DISPLAY_ADD_WIZARD

        static final int DISPLAY_ADD_WIZARD
        Deprecated.
        display flag indicating the filter editor needs to display the add expression wizard
        See Also:
        Constant Field Values

      • DISPLAY_UNIT_COMPARISON

        static final int DISPLAY_UNIT_COMPARISON
        Deprecated.
        display flag indicating the filter editor needs to display the unit comparison box rather than the constant textbox
        See Also:
        Constant Field Values

      • DISPLAY_AQ_EDIT

        static final int DISPLAY_AQ_EDIT
        Deprecated.
        display flag indicating the filter editor needs to display the attribute qualification editing mode
        See Also:
        Constant Field Values

      • NODE_KEY_INVALID

        static final int NODE_KEY_INVALID
        Deprecated.
        constant for invalid node key
        See Also:
        Constant Field Values

      • L_ACTION_INVALID

        static final int L_ACTION_INVALID
        Deprecated.
        action constant for an invalid action
        See Also:
        Constant Field Values

      • L_ACTION_CLEAR_FILTER

        static final int L_ACTION_CLEAR_FILTER
        Deprecated.
        action constant for clear the whole filter
        See Also:
        Constant Field Values

      • L_ACTION_DELETE_EXPRESSION

        static final int L_ACTION_DELETE_EXPRESSION
        Deprecated.
        action constant for deleting a sub expression in the filter
        See Also:
        Constant Field Values

      • L_ACTION_TOGGLE_OPERATOR

        static final int L_ACTION_TOGGLE_OPERATOR
        Deprecated.
        action constant for toggling an operator in the expression
        See Also:
        Constant Field Values

      • L_ACTION_SHIFTUP_EXPRESSION

        static final int L_ACTION_SHIFTUP_EXPRESSION
        Deprecated.
        action constant for shifting up a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_SHIFTDOWN_EXPRESSION

        static final int L_ACTION_SHIFTDOWN_EXPRESSION
        Deprecated.
        action constant for shifting down a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_SHIFTLEFT_OPERATOR

        static final int L_ACTION_SHIFTLEFT_OPERATOR
        Deprecated.
        action constant for shifting left a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_SHIFTRIGHT_OPERATOR

        static final int L_ACTION_SHIFTRIGHT_OPERATOR
        Deprecated.
        action constant for shifting right a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_EDIT_OPERATOR

        static final int L_ACTION_EDIT_OPERATOR
        Deprecated.
        action constant for editing an operator
        See Also:
        Constant Field Values

      • L_ACTION_EDIT_EXPRESSION

        static final int L_ACTION_EDIT_EXPRESSION
        Deprecated.
        action constant for editing a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_CANCEL_EDIT_OPERATOR

        static final int L_ACTION_CANCEL_EDIT_OPERATOR
        Deprecated.
        action constant for cancelling the operator editing
        See Also:
        Constant Field Values

      • L_ACTION_TOGGLE_UNIT_COMPARISON

        static final int L_ACTION_TOGGLE_UNIT_COMPARISON
        Deprecated.
        action constant for toggling between unit comparison and constant comparison
        See Also:
        Constant Field Values

      • L_ACTION_APPLY_EDIT_EXPRESSION

        static final int L_ACTION_APPLY_EDIT_EXPRESSION
        Deprecated.
        action constant for applying the changes for a sub expression editing
        See Also:
        Constant Field Values

      • L_ACTION_CANCEL_EDIT_EXPRESSION

        static final int L_ACTION_CANCEL_EDIT_EXPRESSION
        Deprecated.
        action constant for canceling the changes for a sub expression editing
        See Also:
        Constant Field Values

      • L_ACTION_TOGGLE_AQ_MODE

        static final int L_ACTION_TOGGLE_AQ_MODE
        Deprecated.
        action constant for toggling the attribute qualification between selecting elements and qualification
        See Also:
        Constant Field Values

      • L_ACTION_ADD_EXPRESSION_WIZARD

        static final int L_ACTION_ADD_EXPRESSION_WIZARD
        Deprecated.
        action constant for displaying the wizard for adding a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_ADD_EXPRESSION

        static final int L_ACTION_ADD_EXPRESSION
        Deprecated.
        action constant for adding a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_ADD_SHOPPING_CART_UNIT

        static final int L_ACTION_ADD_SHOPPING_CART_UNIT
        Deprecated.
        action constant for adding an item in a shopping cart
        See Also:
        Constant Field Values

      • L_ACTION_REMOVE_SHOPPING_CART_UNIT

        static final int L_ACTION_REMOVE_SHOPPING_CART_UNIT
        Deprecated.
        action constant for removing an item in a shopping cart
        See Also:
        Constant Field Values

      • L_ACTION_APPLY_ADD_EXPRESSION

        static final int L_ACTION_APPLY_ADD_EXPRESSION
        Deprecated.
        action constant for applying the changes of adding a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_INCREFETCH_BEGIN

        static final int L_ACTION_INCREFETCH_BEGIN
        Deprecated.
        action constant for going to the beginning of the incremental fetch
        See Also:
        Constant Field Values

      • L_ACTION_CANCEL_ADD_EXPRESSION

        static final int L_ACTION_CANCEL_ADD_EXPRESSION
        Deprecated.
        action constant for canceling the changes of adding a sub expression
        See Also:
        Constant Field Values

      • L_ACTION_ELEMENT_SEARCH

        static final int L_ACTION_ELEMENT_SEARCH
        Deprecated.
        action constant for doing an element search
        See Also:
        Constant Field Values

      • L_ACTION_APPLY_VIEWFILTER_CHANGES

        static final int L_ACTION_APPLY_VIEWFILTER_CHANGES
        Deprecated.
        action constant for applying the whole changes of view filter. it's fired when apply button is clicked when autoapply is OFF for view filter editor
        See Also:
        Constant Field Values

      • L_ACTION_CANCEL_VIEWFILTER_CHANGES

        static final int L_ACTION_CANCEL_VIEWFILTER_CHANGES
        Deprecated.
        action constant for canceling the whole changes of view filter. it's fired when cancek button is clicked when autoapply is OFF for view filter editor
        See Also:
        Constant Field Values

      • L_ACTION_MATCH_CASE

        static final int L_ACTION_MATCH_CASE
        Deprecated.
        Constant value read when performing search on elements
        See Also:
        Constant Field Values

      • L_ACTION_CANCEL_ADD_EXPRESSION_WIZARD

        static final int L_ACTION_CANCEL_ADD_EXPRESSION_WIZARD
        Deprecated.
        action constant for canceling the wizard for adding a sub expression
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • L_CREATE_EXP_ATT_QUAL_TYPE

        static final int L_CREATE_EXP_ATT_QUAL_TYPE
        Deprecated.
        Indicates that new Filter expression to be created for an attribute will be always of Attribute qualification type.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • L_CREATE_EXP_ATT_ELEM_TYPE

        static final int L_CREATE_EXP_ATT_ELEM_TYPE
        Deprecated.
        Indicates that new Filter expression to be created for an attribute will be always of Attribute element qualification type.
        However, this mode will be ignored if given attribute is locked in both Filters: View and Report Filters. If this is the case, then an Attribute Qualification expression will be created.
        Since:
        MicroStrategy Web 7.5.1
        See Also:
        Constant Field Values

      • L_CREATE_EXP_DEFAULT_TYPE

        static final int L_CREATE_EXP_DEFAULT_TYPE
        Deprecated.
        Indicates to use default type when creating a new Attribute expression in Filter.
        Default mode defines that an Attribute Qualification expression will be created in Design mode (Report Filter).
        In View mode (View Filter), defines that an Attribute Element qualification expression will be created only if given attribute isn't locked.
        This is the default value for all Filter Editor.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values

      • METRIC_VALIDATION_NUMERICAL

        static final int METRIC_VALIDATION_NUMERICAL
        Deprecated.
        Indicates that only numerical values are taken when creating a Metric filter sub expression.
        Since:
        MicroStrategy Web 7.5.2
        See Also:
        Constant Field Values

      • METRIC_VALIDATION_DATE

        static final int METRIC_VALIDATION_DATE
        Deprecated.
        Indicates that date and numerical are valid values. (default value)
        Since:
        MicroStrategy Web 7.5.2
        See Also:
        Constant Field Values

      • METRIC_VALIDATION_TEXT

        static final int METRIC_VALIDATION_TEXT
        Deprecated.
        Indicates that text, date and numerical are valid values.
        Since:
        MicroStrategy Web 7.5.2
        See Also:
        Constant Field Values

    • Method Detail

      • getDisplayFlag

        int getDisplayFlag()
        Deprecated.
        Returns:
        the filter editor display flags. It is a binary sum of the constants with name beginning with DISPLAY_.

      • setDisplayFlag

        void setDisplayFlag​(int displayFlag)
        Deprecated.
        Sets the filter editor display flags. It is a combination of the constants with name beginning with DISPLAY_.
        Parameters:
        displayFlag - the display flag for the filter editor

      • getActiveNodeKey

        int getActiveNodeKey()
        Deprecated.
        get the currently active expression node key.
        Returns:
        the currently active expression node key.

      • setActiveNodeKey

        void setActiveNodeKey​(int key)
        Deprecated.
        Set the currently active expression node key.
        Parameters:
        key - the active expression node key for the filter editor

      • getActiveOperatorKey

        int getActiveOperatorKey()
        Deprecated.
        get the currently operator node key.
        Returns:
        the currently operator node key.

      • setActiveOperatorKey

        void setActiveOperatorKey​(int key)
        Deprecated.
        Return the currently operator node key.
        Parameters:
        key - the active operator node key for the filter editor

      • getActiveLeftKey

        int getActiveLeftKey()
        Deprecated.
        Returns:
        the currently left node key. Operator node key by itself sometimes can't uniquely identify an operator to work on. For example: Year(ID) = 2000 AND Year(ID) = 2001 AND Year(ID) = 2002 The two "AND" node has the same node key, we need differentiate by left and right node keys

      • setActiveLeftKey

        void setActiveLeftKey​(int key)
        Deprecated.
        Return the currently left node key.
        Parameters:
        key - the active left node key for the filter editor

      • getActiveRightKey

        int getActiveRightKey()
        Deprecated.
        get the currently right node key
        Returns:
        the currently right node key

      • setActiveRightKey

        void setActiveRightKey​(int key)
        Deprecated.
        Return the currently right node key.
        Parameters:
        key - the active right node key for the filter editor

      • isAutoApply

        boolean isAutoApply()
        Deprecated.
        return if auto apply is on or off.
        Returns:
        if auto apply is on or off.

      • setAutoApply

        void setAutoApply​(boolean autoApply)
        Deprecated.
        Set auto apply be on or off
        Parameters:
        autoApply - whether auto apply is on or off

      • getSeparator

        java.lang.String getSeparator()
        Deprecated.
        Return the seperator for filter display. It's the characters displayed before each sub expression.
        Returns:
        the seperator for filter display.

      • setSeparator

        void setSeparator​(java.lang.String separator)
        Deprecated.
        Set the seperator for filter display. It's the characters displayed before each sub expression.
        Parameters:
        separator - the seperator for filter display

      • getFilterType

        int getFilterType()
        Deprecated.
        return the filter type, value is from EnumFilterTypes
        Returns:
        the filter type

      • setFilterType

        void setFilterType​(int filterType)
        Deprecated.
        Set the filter type, value should be from EnumFilterTypes
        Parameters:
        filterType - the filter type

      • getFilter

        WebFilter getFilter()
        Deprecated.
        return the filter object associated with this filter editor
        Returns:
        the filter object associated with this filter editor

      • setFilter

        void setFilter​(WebFilter filter)
        Deprecated.
        Set the filter object associated with this filter editor
        Parameters:
        filter - the filter object

      • getTitle

        java.lang.String getTitle()
        Deprecated.
        return the title for this filter editor. It's show on the interface as the title of the editor.
        Returns:
        the title for this filter editor.

      • setTitle

        void setTitle​(java.lang.String title)
        Deprecated.
        Set the title for this filter editor
        Parameters:
        title - the editor title

      • isEditable

        boolean isEditable()
        Deprecated.
        return whether the filter is editable or not. if editable, it's filter editor; if not, it's filter details.
        Returns:
        whether the filter is editable or not.

      • setEditable

        void setEditable​(boolean editable)
        Deprecated.
        Set whether the filter is editable or not
        Parameters:
        editable - whether the filter is editable

      • isAbleToApply

        boolean isAbleToApply()
        Deprecated.
        return whether the filter expression gets changed, used to indicate whether "apply" button in view filter (when auto-apply is FALSE) shall be DISABLED or not. It's false at first time, then become true after any manipulation in filter editor that changes the filter's expression; and then it will be set to false again when "Apply" or "Cancel" is clicked
        Returns:
        whether the filter expression gets changed

      • setAbleToApply

        void setAbleToApply​(boolean ableToApply)
        Deprecated.
        set whether the filter expression is changed
        Parameters:
        ableToApply - whether the filter expression is changed

      • isAbleToCancel

        boolean isAbleToCancel()
        Deprecated.
        return whether the we can cancel the filter expression changes, used to indicate whether "cancel" button in view filter (when auto-apply is FALSE) shall be DISABLED or not. It's false at first time, then become true for any manipulation in filter editor; and then it will be set to false again when "Apply" or "Cancel" is clicked
        Returns:
        whether the we can cancel the filter expression changes

      • setAbleToCancel

        void setAbleToCancel​(boolean ableToCancel)
        Deprecated.
        set whether the filter expression change can be cancelled
        Parameters:
        ableToCancel - whether the filter expression change can be cancelled

      • getActiveAction

        int getActiveAction()
        Deprecated.
        returns the active action
        Returns:
        the active action

      • setActiveAction

        void setActiveAction​(int activeAction)
        Deprecated.
        Sets active action for the filter editor
        Parameters:
        activeAction - action id

      • getValidationInfo

        WebFilterEditorException getValidationInfo()
        Deprecated.
        Returns the validation info as a WebFilterEditorException
        Returns:
        validation info

      • setValidationInfo

        void setValidationInfo​(WebFilterEditorException wfe)
        Deprecated.
        Sets the ValidationInfo for the filter editor
        Parameters:
        wfe - the validation info as a WebFilterEditorException instance
        Since:
        MicroStrategy Web 8.0.0

      • isDHTML

        boolean isDHTML()
        Deprecated.
        Returns if it's DHTML mode
        Returns:
        boolean

      • setSearchName

        void setSearchName​(java.lang.String searchName)
        Deprecated.
        Sets the search field content
        Parameters:
        searchName - the search name to set

      • setMatchCase

        void setMatchCase​(boolean matchCase)
        Deprecated.
        Sets the match case value
        Parameters:
        matchCase - the match case to set

      • setPerformSearch

        void setPerformSearch​(boolean performaSearch)
        Deprecated.
        set whether it's performing a search
        Parameters:
        performaSearch - whether it's performing a search

      • setIncrementalBlockBegin

        void setIncrementalBlockBegin​(int blockBegin)
        Deprecated.
        setIncrementalBlockBegin, function for setting incremental block begin
        Parameters:
        blockBegin - index for block begin in shopping cart

      • getIncrementalBlockBegin

        int getIncrementalBlockBegin()
        Deprecated.
        getIncrementalBlockBegin, function for getting incremental block begin
        Returns:
        int index for block begin in shopping cart

      • refreshFilter

        void refreshFilter()
        Deprecated.
        reset the filter editor

      • restoreExistingSubExpression

        void restoreExistingSubExpression()
        Deprecated.
        Restores active subexpression to original state.
        Since:
        MicroStrategy Web 7.5.0

      • persistExistingSubExpression

        void persistExistingSubExpression()
        Deprecated.
        Persists active subexpression before being edited.
        Since:
        MicroStrategy Web 7.5.0

      • setIncrementalBlockCount

        void setIncrementalBlockCount​(int count)
        Deprecated.
        setIncrementalBlockCount, function for setting incremental block count
        Parameters:
        count - size of block for shopping cart

      • setContextMenuName

        void setContextMenuName​(java.lang.String contextMenuName)
        Deprecated.
        Specifies name for context Menu.
        Parameters:
        contextMenuName - string

      • validFilterExpression

        boolean validFilterExpression()
        Deprecated.
        Checks whether or not filter expression has an uncompleted element list subexpression.
        Returns:
        true if expression is well formed.

      • isThereAnyOpenCondition

        boolean isThereAnyOpenCondition()
        Deprecated.
        Checks whether or not there's an open subcondition.
        Either it could being added or modified.
        Returns:
        boolean true if at least one opened condition is found.

      • isAttributeLocked

        boolean isAttributeLocked​(WebAttribute attribute)
        Deprecated.
        Whether an attribute is locked or not.
        Parameters:
        attribute - WebAttribute instance to be checked
        Returns:
        boolean true if given attribute is locked.
        Since:
        MicroStrategy Web 7.5.1

      • getCreateAttrExpressionType

        int getCreateAttrExpressionType()
        Deprecated.
        Indicates which type of Attribute Expression is defined when creating a new Filter sub expression.
        This property will determine behavior to take when creating a new Attribute Filter expression. It'll indicate what type of expression to be created.
        This will return an int value indicating any of the following constants:
        • L_CREATE_EXP_ATT_QUAL_TYPE = 1 (Default value in Report Filter)
        • L_CREATE_EXP_ATT_ELEM_TYPE = 2 (Default value in View Filter)
        Returns:
        int attribute expression type.
        Since:
        MicroStrategy Web 7.5.1

      • setCreateAttrExpressionType

        void setCreateAttrExpressionType​(int type)
        Deprecated.
        Specifies which type of Attribute Expression is defined when creating a new Filter sub expression.
        This value will determine behavior to take when creating a new Attribute Filter expression. It'll indicate what type of expression to be created.
        This will ex[ect an int value indicating any of the following constants:
        • L_CREATE_EXP_ATT_QUAL_TYPE = 1 (Default value in Report Filter)
        • L_CREATE_EXP_ATT_ELEM_TYPE = 2 (Default value in View Filter)
        Parameters:
        type - int attribute expression type.
        Since:
        MicroStrategy Web 7.5.1

      • getMetricValidationLevel

        int getMetricValidationLevel()
        Deprecated.
        Indicates the level of validation to be enforced when editing or adding a Metric sub expression.
        It returns only following values denoted in FilterEditor interface:
        Returns:
        the current validation level value for metric sub expressions
        Since:
        MicroStrategy Web 7.5.2

      • setMetricValidationLevel

        void setMetricValidationLevel​(int value)
        Deprecated.
        Specifies level of validation to be enforced when editing or adding a Metric sub expression.
        It takes only following values denoted in FilterEditor interface:
        Parameters:
        value - denotes an integer value which indicates level of validation.
        Since:
        MicroStrategy Web 7.5.2

      • checkMetricValidation

        boolean checkMetricValidation​(int value)
        Deprecated.
        Determines whether or not given metric type of validation is enabled.
        Parameters:
        value - int value possible of following:
        Returns:
        boolean true if enabled.
        Since:
        MicroStrategy Web 7.5.2