com.mlw.vlh
Class ValueListInfo

java.lang.Object
  |
  +--com.mlw.vlh.ValueListInfo

All Implemented Interfaces:

java.io.Serializable

public class ValueListInfo

extends java.lang.Object

implements java.io.Serializable

This VO holds all the information needed to retrieve a ValueList

Author:

Matthew Wilson

See Also:

Serialized Form

Field Summary

static java.lang.Integer	ASCENDING Constant for an ascending order.
static java.lang.Integer	DESCENDING Constant for an descending order.
protected java.util.Map	filters Holds the filters.
protected int	numberPerPage Total number on each page.
protected int	pageNumber Current page desired to display.
protected java.lang.String[]	sortColumns Holds the columns the ValueList is sorted upon.
protected java.lang.Integer[]	sortDirections Holds the columns the ValueList is sorted upon.
protected int	totalNumberOfEntres Total number of pages available.

Constructor Summary

ValueListInfo()

ValueListInfo(java.util.Map filters)
Creates a new ValueListInfo that contains filter information.

ValueListInfo(java.lang.String primaryColumn, java.lang.Integer primaryDirection, java.util.Map filters)
Creates a new ValueListInfo that contains sorting information

Method Summary

java.util.Map	getFilters() Getter for property filters.
int	getNumberPerPage() Getter for the number of VOs per page.
int	getPageNumber() Getter for the curent page to display.
java.lang.String[]	getSortColumn() Returns an array of column (property) names.
java.lang.Integer[]	getSortDirection() Returns an array of directions.
int	getSortLength() Returns the level of sorting information available.
int	getTotalNumberOfEntries() Getter for the total number VOs.
int	getTotalNumberOfPages() Getter for the total number of pages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DESCENDING

public static java.lang.Integer DESCENDING

Constant for an descending order.

ASCENDING

public static java.lang.Integer ASCENDING

Constant for an ascending order.

filters

protected java.util.Map filters

Holds the filters.

sortColumns

protected java.lang.String[] sortColumns

Holds the columns the ValueList is sorted upon.

sortDirections

protected java.lang.Integer[] sortDirections

Holds the columns the ValueList is sorted upon.

pageNumber

protected int pageNumber

Current page desired to display.

totalNumberOfEntres

protected int totalNumberOfEntres

Total number of pages available.

numberPerPage

protected int numberPerPage

Total number on each page.

Constructor Detail

ValueListInfo

public ValueListInfo()

ValueListInfo

public ValueListInfo(java.util.Map filters)

Creates a new ValueListInfo that contains filter information.

Parameters:

filters - Map of filters to apply

ValueListInfo

public ValueListInfo(java.lang.String primaryColumn,
                     java.lang.Integer primaryDirection,
                     java.util.Map filters)

Creates a new ValueListInfo that contains sorting information

Parameters:

primaryColumn - The column to sort by

primaryDirection - The direction to sort the ValueList by

Method Detail

getFilters

public java.util.Map getFilters()

Getter for property filters.

Returns:

Value of property filters.

getSortColumn

public java.lang.String[] getSortColumn()

Returns an array of column (property) names.

Returns:

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

getSortDirection

public java.lang.Integer[] getSortDirection()

Returns an array of directions.

Returns:

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

getSortLength

public int getSortLength()

Returns the level of sorting information available.

Returns:

the level of sorting information available. zero if no sorting information is available.

getPageNumber

public int getPageNumber()

Getter for the curent page to display.

Returns:

the curent page to display.

getTotalNumberOfPages

public int getTotalNumberOfPages()

Getter for the total number of pages.

Returns:

the total number of pages.

getTotalNumberOfEntries

public int getTotalNumberOfEntries()

Getter for the total number VOs.

Returns:

the total number of VOs.

getNumberPerPage

public int getNumberPerPage()

Getter for the number of VOs per page.

Returns:

the number of VOs per page.