org.ow2.dragon.persistence.dao
Class RequestOptions

java.lang.Object
  org.ow2.dragon.persistence.dao.RequestOptions

public class RequestOptions
extends java.lang.Object

Defines options for requesting DragonDataBase.

This allows defining sort and pagination options when requesting the DragonDataBase

Constructor Summary

RequestOptions()

Method Summary

java.lang.String	getFetchCriteria()
int	getFirstResult() Returns the requested first result index.
int	getNbOfResults() Returns the requested number of results.
java.lang.String	getSortCriteria() Returns the sort criteria ID
boolean	hasFetchOption() Determines whether sort options are set
boolean	hasPagination() Determines whether pagination options are set
boolean	hasSortOption() Determines whether sort options are set
boolean	isCaseSensitive()
boolean	isSortAscendingly() Determines whether sort is ascending.
void	setCaseSensitive(boolean caseSensitive)
void	setFetchCriteria(java.lang.String fetchCriteria)
void	setFirstResult(int firstResult) Sets the requested first result index.
void	setNbOfResults(int nbOfResults) Sets the requested number of results.
void	setSortAscendingly(boolean sortAscendingly) Sets whether sort is ascending.
void	setSortCriteria(java.lang.String sortColumn) Sets the sort criteria ID

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestOptions

public RequestOptions()

Method Detail

hasPagination

public boolean hasPagination()

Determines whether pagination options are set

Returns:

hasSortOption

public boolean hasSortOption()

Determines whether sort options are set

Returns:

hasFetchOption

public boolean hasFetchOption()

Determines whether sort options are set

Returns:

getFirstResult

public int getFirstResult()

Returns the requested first result index.

This the pagination offset

Returns:

setFirstResult

public void setFirstResult(int firstResult)

Sets the requested first result index.

Parameters:

firstResult -

getNbOfResults

public int getNbOfResults()

Returns the requested number of results.

This the pagination length

Returns:

setNbOfResults

public void setNbOfResults(int nbOfResults)

Sets the requested number of results.

Parameters:

nbOfResults -

isSortAscendingly

public boolean isSortAscendingly()

Determines whether sort is ascending.

Returns:

setSortAscendingly

public void setSortAscendingly(boolean sortAscendingly)

Sets whether sort is ascending.

Parameters:

sortAscendingly -

getSortCriteria

public java.lang.String getSortCriteria()

Returns the sort criteria ID

Returns:

setSortCriteria

public void setSortCriteria(java.lang.String sortColumn)

Sets the sort criteria ID

Parameters:

sortColumn -

isCaseSensitive

public boolean isCaseSensitive()

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

getFetchCriteria

public java.lang.String getFetchCriteria()

setFetchCriteria

public void setFetchCriteria(java.lang.String fetchCriteria)