net.mlw.vlh
Interface PagingInfo

All Known Implementing Classes:

ValueListInfo

public interface PagingInfo

Version:

$Revision: 1.6 $ $Date: 2006/03/29 19:47:49 $

Author:

Matthew L. Wilson, Andrej Zachar

Method Summary

String	getFocusProperty()
byte	getFocusStatus()
String	getFocusValue()
int	getPagingNumberPer() Getter for the number of VOs per page.
int	getPagingPage() Getter for the curent page to display.
String	getSortingColumn() Returns an array of column (property) names.
Integer	getSortingDirection() Returns an array of directions.
int	getTotalNumberOfEntries() Getter for the total number VOs.
int	getTotalNumberOfPages() Getter for the total number VOs.
boolean	isDoFocus()
boolean	isDoFocusAgain() Used for generating links, if any errors found, doFocus is set to false for next retrieving of the valueList.
boolean	isFocusEnabled() Return true if the focusing is enabled.

Method Detail

getSortingColumn

public String getSortingColumn()

Returns an array of column (property) names.

Returns:

a String array of column (property) names. null if no sorting information exists.

getSortingDirection

public Integer getSortingDirection()

Returns an array of directions.

Returns:

an Integer array of directions. null if no sorting information exists.

getPagingPage

public int getPagingPage()

Getter for the curent page to display.

Returns:

the curent page to display.

getPagingNumberPer

public int getPagingNumberPer()

Getter for the number of VOs per page. -1 if it is not set.

Returns:

the number of VOs per page.

getTotalNumberOfEntries

public int getTotalNumberOfEntries()

Getter for the total number VOs.

Returns:

the total number of VOs.

getTotalNumberOfPages

public int getTotalNumberOfPages()

Getter for the total number VOs.

Returns:

the total number of VOs.

getFocusProperty

public String getFocusProperty()

Returns:

The property used for focusing.

getFocusValue

public String getFocusValue()

Returns:

The value for focusing.

isFocusEnabled

public boolean isFocusEnabled()

Return true if the focusing is enabled.

Returns:

boolean

isDoFocus

public boolean isDoFocus()

Returns:

true if is set DoFocus true

isDoFocusAgain

public boolean isDoFocusAgain()

Used for generating links, if any errors found, doFocus is set to false for next retrieving of the valueList.

Returns:

boolean

getFocusStatus

public byte getFocusStatus()