Package org.kuali.rice.krad.util

Class QueryPagingRequest

java.lang.Object

org.kuali.rice.krad.util.QueryPagingRequest

All Implemented Interfaces:

Serializable

public final class QueryPagingRequest
extends Object
implements Serializable

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
QueryPagingRequest(int startAtIndex, int maxResults)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	getMaxResults()	Returns the maximum number of results that this query is requesting to receive.
int	getStartAtIndex()	Returns the optional zero-based "start" index for rows returned.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QueryPagingRequest

public QueryPagingRequest(int startAtIndex,
 int maxResults)

Method Details

getStartAtIndex

public int getStartAtIndex()

Returns the optional zero-based "start" index for rows returned. When this query is executed, this property should be read to determine the first row which should be returned. If the given index is beyond the end of the result set, then the resulting query should effectively return no rows (as opposed to producing an index-based out of bounds error).

Will never be less than 0

Returns:

the starting row index requested by this query, or null if the results should start at the beginning of the result set

getMaxResults

public int getMaxResults()

Returns the maximum number of results that this query is requesting to receive. If the number request is larger than the number of results then all results are returned.

Will never be less than 0

Returns:

the maximum number of results to return from the query

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object