com.lexmark.saperion.search

Class PageDefinition

java.lang.Object

com.lexmark.saperion.search.PageDefinition

All Implemented Interfaces:

Serializable

public class PageDefinition
extends Object
implements Serializable

The collection page parameter defines a specific section in the collection result set which is returned by the collection's list method.

Author:

owaeldrich

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_OFFSET
static int	DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
PageDefinition() Default constructor.
PageDefinition(int offset, int pageSize) Constructs a new paging parameter with the given page offset and number of elements per page.

Method Summary

Modifier and Type	Method and Description
int	getOffset() Returns the offset in the paged collection.
int	getPageSize() Returns the maximum number of elements in a page.
void	setOffset(int offset) Sets the offset in the paged collection.
void	setPageSize(int pageSize) Sets the maximum number of elements in a page.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OFFSET

public static final int DEFAULT_OFFSET

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

PageDefinition

public PageDefinition()

Default constructor.

PageDefinition

public PageDefinition(int offset,
                      int pageSize)

Constructs a new paging parameter with the given page offset and number of elements per page.

Parameters:

offset - the page offset

pageSize - the number of elements per page

Method Detail

getPageSize

public int getPageSize()

Returns the maximum number of elements in a page.

Returns:

number of elements in a page

setPageSize

public void setPageSize(int pageSize)

Sets the maximum number of elements in a page.

Parameters:

pageSize - the maximum number of elements in the page to set

getOffset

public int getOffset()

Returns the offset in the paged collection.

Returns:

the offset in the paged collection

setOffset

public void setOffset(int offset)

Sets the offset in the paged collection.

Parameters:

offset - the offset in the paged collection to set