Package com.microstrategy.web.objects

Interface WebSubscriptionEMMACubeOptions

  • All Known Implementing Classes:
    WebSubscriptionEMMACubeOptionsImpl
    public interface WebSubscriptionEMMACubeOptions
    Object to represent EMMA cube related options in subscription

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clear()
      Clear all current setting
      int getAllLevelAction()
      Get cube level execute action
      int getAllLevelRefreshType()
      Get cube level refresh type
      java.lang.String[] getAllTables()
      Get Array of all tables's ID.
      boolean getIRRState()
      Gets the state of whether Incremental Refresh Report Instance is used
      java.lang.String getMessageID()
      Gets the message ID of Incremental Refresh Report Instance
      boolean getOldIRRState()
      Gets the old state of whether Incremental Refresh Report Instance is used
      java.lang.String getRawXML()
      Get raw XML description about this options
      int getTableAction​(java.lang.String tableID)
      Get table level execute action
      int getTableRefreshType​(java.lang.String tableID)
      Get table level refresh type
      boolean isAllLevelActionSet()
      Function to tell if cube level execution action was set
      boolean isAllLevelRefreshTypeSet()
      Function to tell if cube level refresh type was set
      void setAllLevelAction​(int ac)
      Set cube level execute action
      void setAllLevelRefreshType​(int crb)
      Set cube level refresh type, value comes from EnumDSSCubeRefreshType
      void setIRRState​(boolean hasIRR)
      Sets the state of whether Incremental Refresh Report Instance is used
      void setMessageID​(java.lang.String msgID)
      Sets the message ID of Incremental Refresh Report Instance
      void setOldIRRState​(boolean hasIRR)
      Sets the old state of whether Incremental Refresh Report Instance is used
      void setTableAction​(java.lang.String tableID, int crb)
      Set table level execute action
      void setTableRefreshType​(java.lang.String tableID, int crb)
      Set table level refresh type

    • Method Detail

      • getAllLevelRefreshType

        int getAllLevelRefreshType()
        Get cube level refresh type
        Returns:
        EnumDSSXMLCubeRefreshType

      • setAllLevelRefreshType

        void setAllLevelRefreshType​(int crb)
        Set cube level refresh type, value comes from EnumDSSCubeRefreshType
        Parameters:
        crb - EnumDSSXMLTableStateExecutionAction

      • isAllLevelRefreshTypeSet

        boolean isAllLevelRefreshTypeSet()
        Function to tell if cube level refresh type was set
        Returns:
        true if it was set before

      • getAllLevelAction

        int getAllLevelAction()
        Get cube level execute action
        Returns:
        table level execute action EnumDSSXMLTableStateExecutionAction

      • setAllLevelAction

        void setAllLevelAction​(int ac)
        Set cube level execute action
        Parameters:
        ac - EnumDSSXMLTableStateExecutionAction

      • isAllLevelActionSet

        boolean isAllLevelActionSet()
        Function to tell if cube level execution action was set
        Returns:
        true if it was set before

      • clear

        void clear()
        Clear all current setting

      • getTableRefreshType

        int getTableRefreshType​(java.lang.String tableID)
        Get table level refresh type
        Parameters:
        tableID -
        Returns:
        EnumDSSXMLCubeRefreshType

      • setTableRefreshType

        void setTableRefreshType​(java.lang.String tableID,
                         int crb)
        Set table level refresh type
        Parameters:
        tableID -
        crb - EnumDSSXMLCubeRefreshType

      • getTableAction

        int getTableAction​(java.lang.String tableID)
        Get table level execute action
        Parameters:
        tableID -
        Returns:
        EnumDSSXMLTableStateExecutionAction

      • setTableAction

        void setTableAction​(java.lang.String tableID,
                    int crb)
        Set table level execute action
        Parameters:
        tableID -
        crb - EnumDSSXMLTableStateExecutionAction

      • getAllTables

        java.lang.String[] getAllTables()
        Get Array of all tables's ID.
        Returns:
        array of all current tables ID

      • getRawXML

        java.lang.String getRawXML()
        Get raw XML description about this options
        Returns:

      • setIRRState

        void setIRRState​(boolean hasIRR)
        Sets the state of whether Incremental Refresh Report Instance is used
        Parameters:
        hasIRR -

      • getIRRState

        boolean getIRRState()
        Gets the state of whether Incremental Refresh Report Instance is used
        Returns:
        true if it was set before

      • setOldIRRState

        void setOldIRRState​(boolean hasIRR)
        Sets the old state of whether Incremental Refresh Report Instance is used
        Parameters:
        hasIRR -

      • getOldIRRState

        boolean getOldIRRState()
        Gets the old state of whether Incremental Refresh Report Instance is used
        Returns:
        true if it was set before

      • setMessageID

        void setMessageID​(java.lang.String msgID)
        Sets the message ID of Incremental Refresh Report Instance
        Parameters:
        msgID -

      • getMessageID

        java.lang.String getMessageID()
        Gets the message ID of Incremental Refresh Report Instance
        Returns:
        msgID