Package com.microstrategy.web.objects.rw

Interface RWIncrementalFetchSettings

  • public interface RWIncrementalFetchSettings
    The RWIncrementalFetchSettings interface allows the user to set the window of document results that the Intelligence Server should return. This object can only be obtained from RWInstance.
    Since:
    MicroStrategy Web 9.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getBlockBegin()  
      int getBlockCount()  
      java.lang.String getGBKey()  
      int getMaxCols()
      Gets the maximum number of rows value for the window settings applied.
      int getMaxRows()
      Gets the maximum number of rows value for the window settings applied.
      int getTotalBlocks()  
      int getTotalElements()  
      boolean isEnabled()
      Returns true if the Incremental Fetch is enabled in this document.
      boolean isFetchAvailable()
      Returns true if the Incremental fetch is enabled in the document and the data allows us to perform an incremental fetch.
      void setBlockBegin​(int value)  
      void setBlockCount​(int value)  
      void setEnabled​(boolean value)
      Sets whether the Incremental fetch is enabled in this document.
      void setGBKey​(java.lang.String value)  
      void setMaxCols​(int value)
      Sets the maximum number of rows for the window setting to be applied.
      void setMaxRows​(int value)
      Sets the maximum number of rows for the window setting to be applied.

    • Method Detail

      • getGBKey

        java.lang.String getGBKey()

      • getBlockBegin

        int getBlockBegin()

      • setBlockBegin

        void setBlockBegin​(int value)

      • getBlockCount

        int getBlockCount()

      • getTotalElements

        int getTotalElements()

      • getTotalBlocks

        int getTotalBlocks()

      • isEnabled

        boolean isEnabled()
        Returns true if the Incremental Fetch is enabled in this document.
        Returns:
        true if Incremental Fetch is enabled
        See Also:
        isFetchAvailable()

      • setEnabled

        void setEnabled​(boolean value)
         throws WebObjectsException
        Sets whether the Incremental fetch is enabled in this document.
        Parameters:
        value - boolean value to enable or disable.
        Throws:
        WebObjectsException

      • isFetchAvailable

        boolean isFetchAvailable()
        Returns true if the Incremental fetch is enabled in the document and the data allows us to perform an incremental fetch.
        Returns:
        true only if the incremental fetch is possible based on the data.

      • setMaxRows

        void setMaxRows​(int value)
        Sets the maximum number of rows for the window setting to be applied. It corresponds to the wmr in the window settings.
        Parameters:
        value - representing the max rows for the incremental fetch

      • getMaxRows

        int getMaxRows()
        Gets the maximum number of rows value for the window settings applied. It corresponds to the wmr in the window settings.
        Returns:
        an int representing the maximum number of rows to be fetched.

      • setMaxCols

        void setMaxCols​(int value)
        Sets the maximum number of rows for the window setting to be applied. It corresponds to the wmc in the window settings.
        Parameters:
        value - representing the max columns for the incremental fetch

      • getMaxCols

        int getMaxCols()
        Gets the maximum number of rows value for the window settings applied. It corresponds to the wmc in the window settings.
        Returns:
        an int representing the maximum number of columns to be fetched.