de.hybris.platform.webservices.paging.impl

Class QueryPagingStrategy

java.lang.Object

de.hybris.platform.webservices.paging.impl.QueryPagingStrategy

All Implemented Interfaces:

PagingStrategy

public class QueryPagingStrategy
extends java.lang.Object
implements PagingStrategy

Constructor Summary

Constructors

Constructor and Description
QueryPagingStrategy()

Method Summary

Modifier and Type	Method and Description
java.lang.Object	executeCollectionTypePaging(PageInfoCtx pagingInfo, java.lang.Object value) Deprecated. after CollectionTypes will be replaced with RelationTypes(since 5.0.0) this method will be useless. There will be no need to implement this method. The executeRelationTypePaging method will be used instead of this.
java.lang.Object	executeRelationTypePaging(PageInfoCtx pagingInfo, RelationDescriptorModel relDesc, java.lang.Object model) Returns a paginated collection which is specified by pagingInfo and comes from N:M relation OR a paginated collection which comes from 1:N relation.
java.lang.Object	executeRootCollectionPaging(PageInfoCtx pagingInfo, java.lang.String typeCode) Returns a collection which comes from Root Resource(possibly paginated).
PageInfoCtx	findPageContext(java.lang.String collectionPropertyName, java.util.Map<java.lang.String,java.util.List<java.lang.String>> queryParams) Returns page context if query parameters and collection property name suit each other.
FlexibleSearchService	getFlexibleSearchService()
ModelService	getModelService()
void	setFlexibleSearchService(FlexibleSearchService flexibleSearchService)
void	setModelService(ModelService modelService)

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryPagingStrategy

public QueryPagingStrategy()

Method Detail

getModelService

public ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getFlexibleSearchService

public FlexibleSearchService getFlexibleSearchService()

setFlexibleSearchService

public void setFlexibleSearchService(FlexibleSearchService flexibleSearchService)

findPageContext

public PageInfoCtx findPageContext(java.lang.String collectionPropertyName,
                                   java.util.Map<java.lang.String,java.util.List<java.lang.String>> queryParams)

Returns page context if query parameters and collection property name suit each other. If not, the null is returned.

Specified by:

findPageContext in interface PagingStrategy

Parameters:

collectionPropertyName - The Name of the collection property.

queryParams - Query parameters which comes from requested URL.

Returns:

page context if query parameters and collection property name suit each other. If not, the null is returned.

executeRootCollectionPaging

public java.lang.Object executeRootCollectionPaging(PageInfoCtx pagingInfo,
                                                    java.lang.String typeCode)

Returns a collection which comes from Root Resource(possibly paginated).

Solution based on FlexibleSearch.

Specified by:

executeRootCollectionPaging in interface PagingStrategy

Parameters:

pagingInfo - Holds all required information about paging settings.

typeCode - The requested type code of collection elements.

Returns:

a collection which comes from Root Resource(possibly paginated).

executeRelationTypePaging

public java.lang.Object executeRelationTypePaging(PageInfoCtx pagingInfo,
                                                  RelationDescriptorModel relDesc,
                                                  java.lang.Object model)

Returns a paginated collection which is specified by pagingInfo and comes from N:M relation OR a paginated collection which comes from 1:N relation.

Solution based on FlexibleSearch.

Specified by:

executeRelationTypePaging in interface PagingStrategy

Parameters:

pagingInfo - Holds all required information about paging settings.

relDesc - The relation descriptor.

model - The instance of model which holds the returned collection.

Returns:

a paginated collection which is specified by pagingInfo and comes from N:M relation OR a paginated collection which comes from 1:N relation.

executeCollectionTypePaging

@Deprecated
public java.lang.Object executeCollectionTypePaging(PageInfoCtx pagingInfo,
                                                                java.lang.Object value)

Deprecated. after CollectionTypes will be replaced with RelationTypes(since 5.0.0) this method will be useless. There will be no need to implement this method. The executeRelationTypePaging method will be used instead of this.

If input collection is not empty then will be paginated otherwise passed without any change.

Specified by:

executeCollectionTypePaging in interface PagingStrategy

Parameters:

pagingInfo - Holds all required information about paging settings.

value - The collection which will be paginated.

Returns:

if input collection is not empty then will be paginated otherwise passed without any change.