atg.servlet

Class ListingRequest

java.lang.Object

atg.servlet.ListingRequest

public class ListingRequest
extends java.lang.Object

A simple bean that encapsulates paging and sorting parameters for a request.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected boolean	mCalculateTotalAvailable If true, calculates the total number of items before ranging.
protected QueryOptions	mQueryOptions The query options.

Constructor Summary

Constructors

Constructor and Description
ListingRequest() Constructs an instanceof ListingRequest
ListingRequest(QueryOptions pQueryOptions) Construct listing request from query options.

Method Summary

Modifier and Type	Method and Description
Query	andQueryWithBaseQuery(Query pQuery, RepositoryView pView, java.lang.String pIdAlias) And the specified query with any base query that will be created based on the previously parsed query params used to generate this ListingRequest.
Query	createAfterQuery(RepositoryView pView, java.lang.String pIdAlias) Create the after query.
java.util.List<Query>	createBaseQueryList(RepositoryView pView, java.lang.String pIdAlias) Create our base query.
Query	createQueryFromRql(RepositoryView pView) Return the Query from the RQL statement.
java.lang.String	getAfter() Returns property after.
int	getEndingIndex() Gets the ending index
int	getLimit() Returns the limit valued passed in via query parameters.
QueryOptions	getQueryOptions() Repository Query options for this request
protected RepositoryPropertyDescriptor	getRepositoryIdPropertyDescriptor(RepositoryItemDescriptor pItemDesc) Return the string name of the repository id.
RqlStatement	getRqlStatement() Returns property rqlStatement.
java.lang.String	getRqlString() Returns property rqlString.
SortDirectives	getSort() Gets the sort directives for this list
int	getStartingIndex() Gets the starting index
boolean	isCalculateTotalAvailable()
boolean	isExpanded() Returns property expanded.
boolean	isGetForUpdate() Returns property getForUpdate.
boolean	isIncludeRqlInQueryGeneration() Returns property includeRqlInQueryGeneration.
void	range(int pStartingIndex, int pEndingIndex) Sets the range for this ListingRequest instance.
void	setAfter(java.lang.String pAfter) Sets property after.
void	setCalculateTotalAvailable(boolean pCalculateTotalAvailable) Sets total number of items available in the set of items available for the criteria that created this list
void	setEndingIndex(int pEndingIndex) Sets the ending index
void	setExpanded(boolean pExpanded) Sets property expanded.
void	setGetForUpdate(boolean pGetForUpdate) Sets property getForUpdate.
void	setIncludeRqlInQueryGeneration(boolean pIncludeRqlInQueryGeneration) Sets property includeRqlInQueryGeneration.
void	setLimit(int pLimit) Sets the limit value passed in via query parameters
void	setRqlStatement(RqlStatement pRqlStatement) Sets property rqlStatement.
void	setRqlString(java.lang.String pRqlString) Sets property rqlString.
void	setSort(SortDirectives pSortDirectives) Sets the sort directives for this list
void	setStartingIndex(int pStartingIndex) Sets the starting index
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

mQueryOptions

protected QueryOptions mQueryOptions

The query options.

mCalculateTotalAvailable

protected boolean mCalculateTotalAvailable

If true, calculates the total number of items before ranging. Rest spec says to default to false. But we need this to calculate property prev/next links anyways so it really saves nothing to turn it off.

Constructor Detail

ListingRequest

public ListingRequest()

Constructs an instanceof ListingRequest

ListingRequest

public ListingRequest(QueryOptions pQueryOptions)

Construct listing request from query options.

Parameters:

pQueryOptions - the query options.

Method Detail

getLimit

public int getLimit()

Returns the limit valued passed in via query parameters.

Returns:

the limit

setLimit

public void setLimit(int pLimit)

Sets the limit value passed in via query parameters

Parameters:

pLimit - the limit to set

setCalculateTotalAvailable

public void setCalculateTotalAvailable(boolean pCalculateTotalAvailable)

Sets total number of items available in the set of items available for the criteria that created this list

Parameters:

pCalculateTotalAvailable - total number of items available

isCalculateTotalAvailable

public boolean isCalculateTotalAvailable()

Returns:

the total number of items available in the set of items available for the criteria that created this list

setStartingIndex

public void setStartingIndex(int pStartingIndex)

Sets the starting index

Parameters:

pStartingIndex - the starting index of the set of items in this list (inclusive)

getStartingIndex

public int getStartingIndex()

Gets the starting index

Returns:

the starting index of the set of items in this list (inclusive)

setEndingIndex

public void setEndingIndex(int pEndingIndex)

Sets the ending index

Parameters:

pEndingIndex - the ending index of the set of items in this list (exclusive)

getEndingIndex

public int getEndingIndex()

Gets the ending index

Returns:

the ending index of the set of products in this list (exclusive)

setSort

public void setSort(SortDirectives pSortDirectives)

Sets the sort directives for this list

Parameters:

pSortDirectives - the sort directives for this list

getSort

public SortDirectives getSort()

Gets the sort directives for this list

Returns:

the sort directives for this list

getQueryOptions

public QueryOptions getQueryOptions()

Repository Query options for this request

Returns:

The query options for the request.

setAfter

public void setAfter(java.lang.String pAfter)

Sets property after. The value in the sort order that returned items should be after.

Parameters:

pAfter - the value in the sort order that returned items should be after.

getAfter

public java.lang.String getAfter()

Returns property after. The value in the sort order that returned items should be after.

Returns:

the value in the sort order that returned items should be after.

setRqlString

public void setRqlString(java.lang.String pRqlString)

Sets property rqlString. Holds the unparsed form any RQL (from the "q" parameter).

Parameters:

pRqlString - the RQL query string.

getRqlString

public java.lang.String getRqlString()

Returns property rqlString. Holds the unparsed form any RQL (from the "q" parameter).

Returns:

the RQL query string.

setIncludeRqlInQueryGeneration

public void setIncludeRqlInQueryGeneration(boolean pIncludeRqlInQueryGeneration)

Sets property includeRqlInQueryGeneration. Whether to parse the RqlString (if any) and include it in the query generation. Honored by createBaseQueryList() and andQueryWithBaseQuery().

Parameters:

pIncludeRqlInQueryGeneration - true if RqlString should be used.

isIncludeRqlInQueryGeneration

public boolean isIncludeRqlInQueryGeneration()

Returns property includeRqlInQueryGeneration. Whether to parse the RqlString (if any) and include it in the query generation. Honored by createBaseQueryList() and andQueryWithBaseQuery().

Returns:

true if RqlString should be used.

setExpanded

public void setExpanded(boolean pExpanded)

Sets property expanded. Whether to expand the product list based on variant property selection is decided by this property. If the property is set true then the catalog is expanded to show based on variant property values e.g. for Blue, Green and Red as for color variant values

Parameters:

pExpanded - true if listing is to be expanded.

isExpanded

public boolean isExpanded()

Returns property expanded. Whether to expand the product list based on variant property selection is decided by this property.

Returns:

true if listing is to be expanded.

setGetForUpdate

public void setGetForUpdate(boolean pGetForUpdate)

Sets property getForUpdate. If true indicates the user plans to use this GET as input for a PATCH update. This needs identified so all the non-paged collection item ids will output alongside paged item details, to prevent the PATCH from deleting un-paged items

Parameters:

pGetForUpdate - true if GET output will be used as input for a PATCH

isGetForUpdate

public boolean isGetForUpdate()

Returns property getForUpdate. If true indicates that the user plans to use this GET as input for a PATCH update. All the non-paged collection item ids will need output, as well as the paged item details, to prevent PATCH from deleting un-paged items.

Returns:

true if GET output will be used as input for a PATCH

setRqlStatement

public void setRqlStatement(RqlStatement pRqlStatement)

Sets property rqlStatement. The RQL statement parsed from the "q" parameter.

Parameters:

pRqlStatement - the RQL statement

getRqlStatement

public RqlStatement getRqlStatement()
                             throws javax.servlet.ServletException

Returns property rqlStatement. The RQL statement parsed from the "q" parameter.

Returns:

the RQL statement.

Throws:

javax.servlet.ServletException - if the defined RQL statement cannot be parsed.

range

public void range(int pStartingIndex,
                  int pEndingIndex)

Sets the range for this ListingRequest instance.

Parameters:

pStartingIndex - the starting index (inclusive)

pEndingIndex - the ending index (exclusive)

andQueryWithBaseQuery

public Query andQueryWithBaseQuery(Query pQuery,
                                   RepositoryView pView,
                                   java.lang.String pIdAlias)
                            throws javax.servlet.ServletException

And the specified query with any base query that will be created based on the previously parsed query params used to generate this ListingRequest. Will return pQuery if there's nothing to "and" with.

Parameters:

pQuery - the query to and with the base query (if any). May be null.

pView - the view to create the after query from.

pIdAlias - an additional alias for the ID property, other than it's repository property name. May be null.

Returns:

a query (possibly pQuery). Will not return null.

Throws:

javax.servlet.ServletException - should a failure happen interacting with repository.

createBaseQueryList

public java.util.List<Query> createBaseQueryList(RepositoryView pView,
                                                 java.lang.String pIdAlias)
                                          throws javax.servlet.ServletException,
                                                 RepositoryException

Create our base query.

Parameters:

pView - the view to create the after query from.

pIdAlias - an additional alias for the ID property, other than it's repository property name. May be null.

Returns:

the (possibly empty) list of base queries that should be and-ed together.

Throws:

RepositoryException - if error occurs interacting with repository.

javax.servlet.ServletException - if property specified for the sort is restricted or invalid.

createAfterQuery

public Query createAfterQuery(RepositoryView pView,
                              java.lang.String pIdAlias)
                       throws javax.servlet.ServletException,
                              RepositoryException

Create the after query. This method is public so can be invoked separately from createBaseQuery().

Parameters:

pView - the view to create the after query from.

pIdAlias - an additional alias for the ID property, other than it's repository property name. May be null.

Returns:

the query (if our "after" property is non-null) or null.

Throws:

RepositoryException - if error occurs interacting with repository.

javax.servlet.ServletException - if property specified for the sort is restricted or invalid.

createQueryFromRql

public Query createQueryFromRql(RepositoryView pView)
                         throws javax.servlet.ServletException,
                                RepositoryException

Return the Query from the RQL statement. If the RQL statement is null, this method returns null.

Parameters:

pView - the view that that query should query

Returns:

the Query or null.

Throws:

RepositoryException - if error occurs interacting with repository.

javax.servlet.ServletException - if property specified for the sort is restricted or invalid.

getRepositoryIdPropertyDescriptor

protected RepositoryPropertyDescriptor getRepositoryIdPropertyDescriptor(RepositoryItemDescriptor pItemDesc)

Return the string name of the repository id.

Parameters:

pItemDesc - The item descriptor to query.

Returns:

the name of the repository id property, or null if no matching property could be found.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object