Package com.commercetools.api.client

Interface SimplePagedQueryResourceRequest<T extends SimplePagedQueryResourceRequest<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>

All Known Subinterfaces:

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

All Known Implementing Classes:

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

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

Interface with common methods for query endpoints

Method Summary

Modifier and Type	Method	Description
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addLimit(TValue limit)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addOffset(TValue offset)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addPredicateVar(String varName, Collection<TValue> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addPredicateVar(String varName, TValue predicateVar)
default T	addQuery(Function<TQuery,QueryPredicate> fn)
default T	addQuery(Function<TQuery,QueryPredicate> fn, String predicateVar, String predicateVarValue)
default T	addQuery(Function<TQuery,QueryPredicate> fn, Collection<Map.Entry<String,String>> predicateVar)
default T	addQuery(Function<TQuery,QueryPredicate> fn, Map<String,Collection<String>> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addSort(TValue sort)
default T	addWhere(String where, String predicateVar, String predicateVarValue)
default T	addWhere(String where, Collection<Map.Entry<String,String>> predicateVar)
default T	addWhere(String where, Map<String,Collection<String>> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addWhere(TValue where)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	addWithTotal(TValue withTotal)
default SimplePagedQueryResourceRequest<T,TResult,TQuery>	asPagedQueryResourceRequest()
default T	asPagedQueryResourceRequestToBaseType()
String	getFirstQueryParam(String key)
List<String>	getQueryParam(String key)
List<ApiMethod.ParamEntry<String,String>>	getQueryParams()
TQuery	queryDsl()
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withLimit(TValue limit)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withOffset(TValue offset)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withPredicateVar(String varName, Collection<TValue> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withPredicateVar(String varName, TValue predicateVar)
default T	withQuery(Function<TQuery,QueryPredicate> fn)
default T	withQuery(Function<TQuery,QueryPredicate> fn, String predicateVar, String predicateVarValue)
default T	withQuery(Function<TQuery,QueryPredicate> fn, Collection<Map.Entry<String,String>> predicateVar)
default T	withQuery(Function<TQuery,QueryPredicate> fn, Map<String,Collection<String>> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withSort(TValue sort)
default T	withWhere(String where, String predicateVar, String predicateVarValue)
default T	withWhere(String where, Collection<Map.Entry<String,String>> predicateVar)
default T	withWhere(String where, Map<String,Collection<String>> predicateVar)
<TValue> SimplePagedQueryResourceRequest<T,TResult,TQuery>	withWhere(TValue where)
<TValue> SimplePagedQueryResourceRequest<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

Method Details

withLimit

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

addLimit

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

withOffset

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

addOffset

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

withSort

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

addSort

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

withWhere

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

addWhere

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

withWithTotal

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

addWithTotal

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

withPredicateVar

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

addPredicateVar

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

withPredicateVar

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

addPredicateVar

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

getQueryParams

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

getQueryParam

List<String> getQueryParam(String key)

getFirstQueryParam

String getFirstQueryParam(String key)

asPagedQueryResourceRequest

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

queryDsl

TQuery queryDsl()

withQuery

default T withQuery(Function<TQuery,QueryPredicate> fn)

addQuery

default T addQuery(Function<TQuery,QueryPredicate> fn)

withQuery

default T withQuery(Function<TQuery,QueryPredicate> fn,
 String predicateVar,
 String predicateVarValue)

addQuery

default T addQuery(Function<TQuery,QueryPredicate> fn,
 String predicateVar,
 String predicateVarValue)

withQuery

default T withQuery(Function<TQuery,QueryPredicate> fn,
 Map<String,Collection<String>> predicateVar)

addQuery

default T addQuery(Function<TQuery,QueryPredicate> fn,
 Map<String,Collection<String>> predicateVar)

withQuery

default T withQuery(Function<TQuery,QueryPredicate> fn,
 Collection<Map.Entry<String,String>> predicateVar)

addQuery

default T addQuery(Function<TQuery,QueryPredicate> fn,
 Collection<Map.Entry<String,String>> predicateVar)

withWhere

default T withWhere(String where,
 String predicateVar,
 String predicateVarValue)

addWhere

default T addWhere(String where,
 String predicateVar,
 String predicateVarValue)

withWhere

default T withWhere(String where,
 Map<String,Collection<String>> predicateVar)

addWhere

default T addWhere(String where,
 Map<String,Collection<String>> predicateVar)

withWhere

default T withWhere(String where,
 Collection<Map.Entry<String,String>> predicateVar)

addWhere

default T addWhere(String where,
 Collection<Map.Entry<String,String>> predicateVar)

asPagedQueryResourceRequestToBaseType

default T asPagedQueryResourceRequestToBaseType()