org.eclipse.persistence.jpa.rs.features.paging

Class PageableQueryValidator

java.lang.Object

org.eclipse.persistence.jpa.rs.features.paging.PageableQueryValidator

public final class PageableQueryValidator
extends java.lang.Object

Finds out if a named query is pageable and validates paging parameters.

Author:

Dmitry Kornilov

Constructor Summary

Constructors

Constructor and Description
PageableQueryValidator(PersistenceContext context, java.lang.String queryName, javax.ws.rs.core.UriInfo uri) Creates a validator.

Method Summary

Modifier and Type	Method and Description
int	getLimit() Returns a value of Limit paging parameter.
int	getOffset() Returns a value of Offset paging parameter.
boolean	isFeatureApplicable() Checks if request is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

PageableQueryValidator

public PageableQueryValidator(PersistenceContext context,
                              java.lang.String queryName,
                              javax.ws.rs.core.UriInfo uri)

Creates a validator.

Parameters:

context - persistence context

queryName - query name to validate

uri - request uri

Method Detail

isFeatureApplicable

public boolean isFeatureApplicable()
                            throws JPARSException

Checks if request is valid.

Returns:

true if request is valid and supports pagination, false if request is valid but doesn't support pagination

Throws:

JPARSException - in case of any validation errors

getOffset

public int getOffset()

Returns a value of Offset paging parameter. The value is available only after calling checkParameters method.

Returns:

the Offset value.

getLimit

public int getLimit()

Returns a value of Limit paging parameter. The value is available only after calling checkParameters method.

Returns:

the Limit value.