public interface

RWIncrementalFetchSettings

com.microstrategy.web.objects.rw.RWIncrementalFetchSettings

Class Overview

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.

Summary

Public Methods
abstract int getBlockBegin()
abstract int getBlockCount()
abstract String getGBKey()
abstract int getMaxRows()
Gets the maximum number of rows value for the window settings applied.
abstract int getTotalBlocks()
abstract int getTotalElements()
abstract boolean isEnabled()
Returns true if the Incremental Fetch is enabled in this document.
abstract boolean isFetchAvailable()
Returns true if the Incremental fetch is enabled in the document and the data allows us to perform an incremental fetch.
abstract void setBlockBegin(int value)
abstract void setBlockCount(int value)
abstract void setEnabled(boolean value)
Sets whether the Incremental fetch is enabled in this document.
abstract void setGBKey(String value)
abstract void setMaxRows(int value)
Sets the maximum number of rows for the window setting to be applied.

Public Methods

public abstract int getBlockBegin ()

public abstract int getBlockCount ()

public abstract String getGBKey ()

public abstract 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.

public abstract int getTotalBlocks ()

public abstract int getTotalElements ()

public abstract boolean isEnabled ()

Returns true if the Incremental Fetch is enabled in this document.

Returns
  • true if Incremental Fetch is enabled

public abstract 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.

public abstract void setBlockBegin (int value)

public abstract void setBlockCount (int value)

public abstract void setEnabled (boolean value)

Sets whether the Incremental fetch is enabled in this document.

Parameters
value boolean value to enable or disable.

public abstract void setGBKey (String value)

public abstract 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