Package com.commercetools.api.client

Interface PagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

Type Parameters:

T - the type of the underlying request

TResult - the type of the underlying result model, like category or product.

All Superinterfaces:

ClientRequestCommand<TResult>, RequestCommand<TResult>, SimplePagedQueryResourceRequest<T,TResult,TQuery>

All Known Subinterfaces:

ByProjectKeyApiClientsGetMixin, ByProjectKeyAsAssociateByAssociateIdBusinessUnitsGetMixin, ByProjectKeyAssociateRolesGetMixin, ByProjectKeyAttributeGroupsGetMixin, ByProjectKeyBusinessUnitsGetMixin, ByProjectKeyCartDiscountsGetMixin, ByProjectKeyCartsGetMixin, ByProjectKeyCategoriesGetMixin, ByProjectKeyChannelsGetMixin, ByProjectKeyCustomerGroupsGetMixin, ByProjectKeyCustomersGetMixin, ByProjectKeyCustomObjectsByContainerGetMixin, ByProjectKeyCustomObjectsGetMixin, ByProjectKeyDiscountCodesGetMixin, ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGetMixin, ByProjectKeyInStoreKeyByStoreKeyShoppingListsGetMixin, ByProjectKeyInventoryGetMixin, ByProjectKeyMessagesGetMixin, ByProjectKeyOrdersEditsGetMixin, ByProjectKeyOrdersGetMixin, ByProjectKeyPaymentsGetMixin, ByProjectKeyProductDiscountsGetMixin, ByProjectKeyProductProjectionsGetMixin, ByProjectKeyProductSelectionsGetMixin, ByProjectKeyProductsGetMixin, ByProjectKeyProductTypesGetMixin, ByProjectKeyReviewsGetMixin, ByProjectKeyShippingMethodsGetMixin, ByProjectKeyShoppingListsGetMixin, ByProjectKeyStandalonePricesGetMixin, ByProjectKeyStatesGetMixin, ByProjectKeyStoresGetMixin, ByProjectKeyTaxCategoriesGetMixin, ByProjectKeyTypesGetMixin, ByProjectKeyZonesGetMixin

All Known Implementing Classes:

ByProjectKeyApiClientsGet, ByProjectKeyAsAssociateByAssociateIdBusinessUnitsGet, ByProjectKeyAssociateRolesGet, ByProjectKeyAttributeGroupsGet, ByProjectKeyBusinessUnitsGet, ByProjectKeyCartDiscountsGet, ByProjectKeyCartsGet, ByProjectKeyCategoriesGet, ByProjectKeyChannelsGet, ByProjectKeyCustomerGroupsGet, ByProjectKeyCustomersGet, ByProjectKeyCustomObjectsByContainerGet, ByProjectKeyCustomObjectsGet, ByProjectKeyDiscountCodesGet, ByProjectKeyInStoreKeyByStoreKeyMeShoppingListsGet, ByProjectKeyInStoreKeyByStoreKeyShoppingListsGet, ByProjectKeyInventoryGet, ByProjectKeyMessagesGet, ByProjectKeyOrdersEditsGet, ByProjectKeyOrdersGet, ByProjectKeyPaymentsGet, ByProjectKeyProductDiscountsGet, ByProjectKeyProductProjectionsGet, ByProjectKeyProductSelectionsGet, ByProjectKeyProductsGet, ByProjectKeyProductTypesGet, ByProjectKeyReviewsGet, ByProjectKeyShippingMethodsGet, ByProjectKeyShoppingListsGet, ByProjectKeyStandalonePricesGet, ByProjectKeyStatesGet, ByProjectKeyStoresGet, ByProjectKeyTaxCategoriesGet, ByProjectKeyTypesGet, ByProjectKeyZonesGet

public interface PagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>
extends RequestCommand<TResult>, ClientRequestCommand<TResult>, SimplePagedQueryResourceRequest<T,TResult,TQuery>

Interface with common methods for query endpoints

Method Summary

Modifier and Type	Method	Description
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addExpand(TValue expand)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addLimit(TValue limit)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addOffset(TValue offset)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addPredicateVar(String varName, Collection<TValue> predicateVar)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addPredicateVar(String varName, TValue predicateVar)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addSort(TValue sort)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addWhere(TValue where)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	addWithTotal(TValue withTotal)
default PagedQueryResourceRequest<T,TResult,TQuery>	asPagedQueryResourceRequest()
String	getFirstQueryParam(String key)
List<String>	getQueryParam(String key)
List<ApiMethod.ParamEntry<String,String>>	getQueryParams()
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withExpand(TValue expand)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withLimit(TValue limit)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withOffset(TValue offset)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withPredicateVar(String varName, Collection<TValue> predicateVar)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withPredicateVar(String varName, TValue predicateVar)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withSort(TValue sort)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withWhere(TValue where)
<TValue> PagedQueryResourceRequest<T,TResult,TQuery>	withWithTotal(TValue withTotal)

Methods inherited from interface io.vrap.rmf.base.client.ClientRequestCommand

execute, executeBlocking, executeBlocking

Methods inherited from interface io.vrap.rmf.base.client.RequestCommand

execute, executeBlocking, executeBlocking

Methods inherited from interface com.commercetools.api.client.SimplePagedQueryResourceRequest

addQuery, addQuery, addQuery, addQuery, addWhere, addWhere, addWhere, asPagedQueryResourceRequestToBaseType, queryDsl, withQuery, withQuery, withQuery, withQuery, withWhere, withWhere, withWhere

Method Details

withLimit

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withLimit(TValue limit)

Specified by:

withLimit in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addLimit

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addLimit(TValue limit)

Specified by:

addLimit in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withOffset

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withOffset(TValue offset)

Specified by:

withOffset in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addOffset

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addOffset(TValue offset)

Specified by:

addOffset in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withSort

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withSort(TValue sort)

Specified by:

withSort in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addSort

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addSort(TValue sort)

Specified by:

addSort in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withWhere

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withWhere(TValue where)

Specified by:

withWhere in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addWhere

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addWhere(TValue where)

Specified by:

addWhere in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withExpand

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withExpand(TValue expand)

addExpand

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addExpand(TValue expand)

withWithTotal

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withWithTotal(TValue withTotal)

Specified by:

withWithTotal in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addWithTotal

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addWithTotal(TValue withTotal)

Specified by:

addWithTotal in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withPredicateVar

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withPredicateVar(String varName,
 TValue predicateVar)

Specified by:

withPredicateVar in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addPredicateVar

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addPredicateVar(String varName,
 TValue predicateVar)

Specified by:

addPredicateVar in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

withPredicateVar

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> withPredicateVar(String varName,
 Collection<TValue> predicateVar)

Specified by:

withPredicateVar in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

addPredicateVar

<TValue>
PagedQueryResourceRequest<T,TResult,TQuery> addPredicateVar(String varName,
 Collection<TValue> predicateVar)

Specified by:

addPredicateVar in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

getQueryParams

List<ApiMethod.ParamEntry<String,String>> getQueryParams()

Specified by:

getQueryParams in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

getQueryParam

List<String> getQueryParam(String key)

Specified by:

getQueryParam in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

getFirstQueryParam

String getFirstQueryParam(String key)

Specified by:

getFirstQueryParam in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>

asPagedQueryResourceRequest

default PagedQueryResourceRequest<T,TResult,TQuery> asPagedQueryResourceRequest()

Specified by:

asPagedQueryResourceRequest in interface SimplePagedQueryResourceRequest<T extends PagedQueryResourceRequest<T,TResult,TQuery>,TResult,TQuery>