Package com.microstrategy.web.beans

Interface RWBean

    • Method Detail

      • getRWInstance

        RWInstance getRWInstance()
                  throws WebBeanException
        Returns the report writing document instance.
        Returns:
        the report writing document instance.
        Throws:
        WebBeanException - if there is a problem retrieving the report writing document instance.

      • setViewBeanEventHandler

        void setViewBeanEventHandler​(WebEventHandler handler)
        Sets the event handler for its embedded ViewBean instances.
        Parameters:
        handler - event handler for embedded ViewBean instances.

      • getViewBeanEventHandler

        WebEventHandler getViewBeanEventHandler()
        Returns the event handler used embedded ViewBean instances.
        Returns:
        the event handler used embedded ViewBean instances.

      • setGraphBeanName

        void setGraphBeanName​(java.lang.String name)
        Sets the name for all GraphBean associated with any of its embedded ViewBean instances.
        Parameters:
        name - the name for all GraphBean associated with any of its embedded ViewBean instances.

      • getGraphBeanName

        java.lang.String getGraphBeanName()
        Returns the name associated with all its GraphBean instances.
        Returns:
        the name associated with all its GraphBean instances.

      • getDefinitionWebBean

        WebBean getDefinitionWebBean​(java.lang.String definitionKey)
                      throws WebBeanException

        Returns the embedded definition WebBean associated with the given key. Null if it doesn't exist.

        Parameters:
        definitionKey - WebBean identifier
        Returns:
        WebBean
        Throws:
        WebBeanException - thrown if a problem occurs while searching for the WebBean

      • getDataWebBeans

        java.util.List getDataWebBeans​(java.lang.String definitionKey)
                        throws WebBeanException
        Returns a list of embedded data WebBean instances for the specified RWObject key.

        Several embedded beans may share the same key - this occurs in view mode when a given WebBean is grouped by an attribute (e.g. year) that contains several values (e.g. 2000, 2001) each of which will be mapped to a separate embedded WebBean. This method is used to retrieve these instances. Null returned if no template exists with definition key.

        Parameters:
        definitionKey - the RWObject key.
        Returns:
        list of embedded data WebBean instances.
        Throws:
        WebBeanException - if there is a problem retrieving the list.

      • getExecutionMode

        int getExecutionMode()
        Returns the execution mode.
        Returns:
        the execution mode.
        See Also:
        EnumRWExecutionModes

      • setExecutionMode

        void setExecutionMode​(int mode)
        Sets the execution mode.
        Parameters:
        mode - the execution mode.
        See Also:
        EnumRWExecutionModes

      • getRWSettings

        RWSettings getRWSettings()
        return rwSettings object associated with the current execution mode (getExecutionMode()).
        It can be used as followings:

        String objectID = ""; String executionDelta = ""; getRWBean().setObjectID(objectID) getRWBean().setExecutionMode(EnumRWExecutionModes.RW_MODE_DATA);
        RWSettings settings = getRWBean().getRWSettings();
        settings.setExcutionFlags(settings.getExecutionFlag()|EnumDSSXMLDocExecutionFlags.DssXmlDocExecutionUseRWDCache);
        settings.setExecutionDelta(executionDelta);
        getRWBean().getInstance(); // this call will invoke the the document execution with the new executionFlags and exeucitonDelta and other settings on the RWSettings against IServer
        Returns:
        rwSettings object associated with the current execution mode.

      • getViewFilterBean

        ExpressionBean getViewFilterBean​(java.lang.String key)
                          throws WebBeanException
        Returns the ExpressionBean referring to the view filter of the given node. This call will fail if the key does not refer to a grid/graph node, as that is currently the only node type that view filters are supported on.
        Parameters:
        key - The key of the node whose view filter is being retrieved.
        Returns:
        An ExpressionBean referring to the view filter of the given node.
        Throws:
        WebBeanException - Thrown if an error occurs when getting the view filter.
        Since:
        MicroStrategy Web 8.0.1

      • refresh

        void refresh​(boolean reprompt,
             boolean rerun)
      throws WebBeanException
        Refreshes the underlying objects encapsulated by this bean with the option to reopen the prompt, and whether to rerun against the backend (or use whatever is cached).
        Parameters:
        reprompt - reopen prompts (if any).
        rerun - whether to use the cache in the backend, or re-execute.
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 8.0.1

      • setNoDelatXML

        void setNoDelatXML​(boolean noDelatXML)

      • getVisualizationViewMode

        int getVisualizationViewMode()
                      throws WebBeanException
        Returns the visualization view mode for the RW document. This will tell which visualization view mode the document is expected to be in.
        Returns:
        The current visualization view mode.
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 8.0.2

      • setVisualizationViewMode

        void setVisualizationViewMode​(int mode)
                       throws WebBeanException
        Changes the visualization view mode for the document. This will generally cause an applyChanges with the next collect data call.
        Parameters:
        mode - The new visualization view mode for the document instance.
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 8.0.2

      • isPartialDisplayEnabled

        boolean isPartialDisplayEnabled()
        Returns true if partial display is enabled for rendering this bean
        Returns:
        boolean
        Since:
        MicroStrategy Web 8.1.0

      • disablePartialDisplay

        void disablePartialDisplay()
        Disables partial display mode for rendering this bean
        Since:
        MicroStrategy Web 8.1.0

      • addPartialDisplayUnits

        void addPartialDisplayUnits​(java.util.Enumeration units)
        Adds units to partial display collection
        Parameters:
        units - enumeration of units
        Since:
        MicroStrategy Web 8.1.0

      • addPartialDisplayUnitKeys

        void addPartialDisplayUnitKeys​(java.util.Enumeration keys)
        Adds units to partial display collection using there keys
        Parameters:
        keys - enumeration of unit keys
        Since:
        MicroStrategy Web 8.1.0

      • addCurrentPageKey

        void addCurrentPageKey​(java.lang.String pageKey)
        Sets the current page key.
        Parameters:
        pageKey - It should be the valid current page key. Pass other page's pageKey or other node key could cause unexpected errors.
        Since:
        MicroStrategy Web 11.3.2

      • addPartialDisplayUnit

        void addPartialDisplayUnit​(RWUnitDef unit)
        Adds a unit to partial display collection using its key
        Parameters:
        unit -

      • addPartialDisplayUnit

        void addPartialDisplayUnit​(java.lang.String key)
        Parameters:
        key -

      • getPartialDisplayUnits

        java.util.Set getPartialDisplayUnits()
        Returns a collection of partial display unit keys
        Returns:
        Set
        Since:
        MicroStrategy Web 8.1.0

      • addPartialDisplayUnitFilterProps

        void addPartialDisplayUnitFilterProps​(java.lang.String key,
                                      java.lang.String defnFilters,
                                      java.lang.String dataFilters)
        Helps add partial display unit filters for the resulting JSON per key.
        Parameters:
        key - The node key.
        defnFilters - Delimited string of all the definition properties that need to be filtered in the response.
        dataFilters - Delimited string of all the data properties that need to be filtered in the response.

      • getPartialDisplayUnitDefnFilterProps

        java.util.Map getPartialDisplayUnitDefnFilterProps()
        A Map of all the definition filters for all the node keys.
        Returns:

      • getPartialDisplayUnitDataFilterProps

        java.util.Map getPartialDisplayUnitDataFilterProps()
        A Map of all the data filters for all the node keys.
        Returns:

      • getDataWebBean

        WebBean getDataWebBean​(RWUnit unit)
                throws WebBeanException
        Returns a web bean assosiated with the given data unit
        Parameters:
        unit - data unit
        Returns:
        bean
        Throws:
        WebBeanException
        Since:
        MicroStrategy Web 8.1.0

      • getRWProperty

        WebProperty getRWProperty​(java.lang.String propertySetName,
                          java.lang.String propertyName)
        Gets document property
        Parameters:
        propertySetName - property set name
        propertyName - property name
        Returns:
        property object
        Since:
        MicroStrategy Web 8.1.0

      • getDefaultViewMode

        int getDefaultViewMode()
        Return default view mode when execute this document.
        Since:
        MicroStrategy Web 8.1.0

      • getDefaultViewMode

        int getDefaultViewMode​(boolean lookupDefnIfFails)
        Return default view mode when execute this document.
        Parameters:
        lookupDefnIfFails - If it fails to get the default view mode from the RWInstance's document properties, should we look in the metadata definition?

      • setDefaultViewMode

        void setDefaultViewMode​(int viewMode)
        Sets default document view mode
        Parameters:
        viewMode - view mode
        Since:
        MicroStrategy Web 8.1.0

      • getAvailableViewModes

        int getAvailableViewModes()
        Return available view modes for this documents. Each bit of this integer represents one view mode. First bit is for static view mode, second one is for interactive view mode, the third one for editable view mode, and the forth one is for flash view mode.
        Returns:
        Integer.
        Since:
        MicroStrategy Web 8.1.0

      • setAvailableViewModes

        void setAvailableViewModes​(int viewModes)
        Sets available view mode for the document
        Parameters:
        viewModes - available view modes
        Since:
        MicroStrategy Web 8.1.0

      • getCurrentLayoutKey

        java.lang.String getCurrentLayoutKey()
        Returns the current layout key.
        Returns:
        String
        Since:
        MicroStrategy Web 9.0.0

      • setCurrentLayoutKey

        void setCurrentLayoutKey​(java.lang.String value)
        Sets the current layout key.
        Parameters:
        value - String
        Since:
        MicroStrategy Web 9.0.0

      • getReport2RWSettings

        Report2RWSettings getReport2RWSettings()
        Since:
        MicroStrategy Web 9.0.0

      • setPreviousExecutionMode

        void setPreviousExecutionMode​(int mode)
        Sets the previous execution mode for any messages for which only a message ID is passed in. By doing this, the initial state of the execution mode of the message will be left as-is.
        Parameters:
        mode - The original execution mode of the message.
        Since:
        MicroStrategy Web 9.0.0

      • getPreviousExecutionMode

        int getPreviousExecutionMode()
        Returns the previous execution mode for any messages for which only a message ID is passed in. By setting this, the initial state of the execution mode of the message will be left as-is.
        Returns:
        The previous execution mode, or -1 if not set.
        Since:
        MicroStrategy Web 9.0.0

      • setRWInstance

        void setRWInstance​(RWInstance rwInstance)

      • getAvailableViewMedia

        int getAvailableViewMedia()

      • setNewAnalysis

        @Deprecated
void setNewAnalysis​(boolean isNew)
        Deprecated.
        This method is only used by GUI to workaround some issue in IVE. Shall be removed once IVE finds its own fix. It shall not be used for any other purpose.

      • addUpdatedControlUnit

        void addUpdatedControlUnit​(java.lang.String key)
        Add a unit into the updated control key collection by Key
        Parameters:
        key -

      • getUpdatedControlUnits

        java.util.Set<java.lang.String> getUpdatedControlUnits()
        Returns a collection of updated control keys
        Returns:
        Set
        Since:
        MicroStrategy Web 9.0.3

      • isRWReadonly

        boolean isRWReadonly()

      • getDefinitionViewBean

        RWViewBean getDefinitionViewBean​(java.lang.String key)

      • isJsonMode

        boolean isJsonMode()

      • setJsonMode

        void setJsonMode​(boolean value)

      • addUpdatedNode

        void addUpdatedNode​(java.lang.String key)

      • addUpdatedUnits

        void addUpdatedUnits​(java.lang.String key)

      • addUpdatedObjects

        void addUpdatedObjects​(java.lang.String objectID,
                       int type,
                       int flag)
        Partial update on object feature.
        Parameters:
        objectID -
        type -
        flag -

      • getUpdatedUnits

        java.util.Set<java.lang.String> getUpdatedUnits()

      • freezeState

        void freezeState()
        After this call any changes to the bean will not mark it stale. The freeze will continue until unfreezeBean is called.

      • unfreezeState

        void unfreezeState()
        After this call the changes to the bean will mark it as stale

      • setSupportsUndo

        void setSupportsUndo​(boolean value)
        Sets flag indication that application using this bean supports undo/redo
        Parameters:
        value -

      • getSupportsUndo

        boolean getSupportsUndo()
        Indicate that the application using this bean supports undo/redo
        Returns:

      • setHasCollectedData

        void setHasCollectedData​(boolean hasCollectedData)
        Parameters:
        hasCollectedData -

      • getSaveFolderId

        java.lang.String getSaveFolderId()

      • setSaveFolderId

        void setSaveFolderId​(java.lang.String folderId)

      • getIsPVPartialExecution

        boolean getIsPVPartialExecution()

      • setIsDossier

        void setIsDossier​(boolean isDossier)
        Set a boolean flag to support dossier to run RSD from Dossier shortcut
        Parameters:
        isDossier -

      • getIsDossier

        boolean getIsDossier()
        return a boolean if this bean comes from Dossier shortcut
        Returns:
        boolean

      • getIsFromTemplate

        boolean getIsFromTemplate()
        Indicate whether this bean is created from template.

      • setInnerWidth

        void setInnerWidth​(int width)

      • getInnerWidth

        int getInnerWidth()

      • setInnerHeight

        void setInnerHeight​(int height)

      • getInnerHeight

        int getInnerHeight()