Package com.microstrategy.web.objects

Interface Scrollable

All Known Subinterfaces:

UserEntitiesBean, UserEntitiesBrowserBean, UserEntitiesSelectorBean, UserGroupBean, WebUserGroup

public interface Scrollable

Generic interface representing scrollable collection.

Since:

MicroStrategy Web 8.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static int	FIRST_BLOCK	Constant for first block
static int	NEXT_BLOCK	Constant for next block
static int	PREVIOUS_BLOCK	Constant for previous block

Method Summary

Modifier and Type	Method	Description
int	getBlockPosition()	Returns current block's position
int	getBlockSize()	Returns the size of current block.
void	gotoBlock(int blockIndex)	Goto a certain block.
boolean	hasNextBlock()	Returns whether there is another block following this block.
boolean	hasPreviousBlock()	Returns whether there is another block before this block.
void	setBlockSize(int value)	Sets the block size.

Field Detail

NEXT_BLOCK

static final int NEXT_BLOCK

Constant for next block

See Also:

Constant Field Values

PREVIOUS_BLOCK

static final int PREVIOUS_BLOCK

Constant for previous block

See Also:

Constant Field Values

FIRST_BLOCK

static final int FIRST_BLOCK

Constant for first block

See Also:

Constant Field Values

Method Detail

getBlockSize

int getBlockSize()

Returns the size of current block.

Returns:

int

setBlockSize

void setBlockSize(int value)
           throws MSTRCheckedException

Sets the block size. Each time when this method is called, the current block will reset to the first block.

Parameters:

value - int the new block size

Throws:

MSTRCheckedException - Thrown when error happens during setting this value.

gotoBlock

void gotoBlock(int blockIndex)
        throws MSTRCheckedException,
               java.lang.IllegalArgumentException

Goto a certain block.

Parameters:

blockIndex - int When the value is negative number, it represents the named block FIRST_BLOCK, NEXT_BLOCK, PREVIOUS_BLOCK. When it is non-negative number, it indicates the 0-based absolute block index.

Throws:

MSTRCheckedException - Thrown if an error happended during the action.

java.lang.IllegalArgumentException - Thrown if the input argument is not a valid value.

hasNextBlock

boolean hasNextBlock()
              throws MSTRCheckedException

Returns whether there is another block following this block.

Returns:

boolean Returns true when there is another block following. Returns false when this is the last block.

Throws:

MSTRCheckedException - Thrown if an error happened during this action.

hasPreviousBlock

boolean hasPreviousBlock()
                  throws MSTRCheckedException

Returns whether there is another block before this block.

Returns:

boolean Returns true when there is another block before this one. Returns false when this is the first block.

Throws:

MSTRCheckedException - Thrown if an error happened during this action.

getBlockPosition

int getBlockPosition()
              throws MSTRCheckedException

Returns current block's position

Returns:

int The 1-based block position.

Throws:

MSTRCheckedException - Thrown when an error happened during the action.