QueryRequestMapping

java.lang.Object
- io.sphere.internal.request.QueryRequestMapping<A,B>

All Implemented Interfaces:

QueryRequest

Direct Known Subclasses:

ProductQueryRequest
```
public abstract class QueryRequestMapping<A,B>
extends java.lang.Object
implements QueryRequest
```
Converts a QueryRequest<A> in a QueryRequest.

Constructor Summary

Constructors
Modifier Constructor and Description

protected QueryRequestMapping(QueryRequest<A> delegate)

Constructors
Modifier	Constructor and Description
`protected`	`QueryRequestMapping(QueryRequest<A> delegate)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract B`	`convert(A a)` Override this method to convert elements from A to B.
`QueryRequest<B>`	`expand(java.lang.String... paths)` Requests Reference fields to be expanded in the returned objects.
`QueryResult<B>`	`fetch()` Executes the request and returns the result.
`com.google.common.util.concurrent.ListenableFuture<QueryResult<B>>`	`fetchAsync()` Executes the request asynchronously and returns a future providing the result.
`QueryRequest<B>`	`page(int page)` Sets the page number for paging through results.
`QueryRequest<B>`	`pageSize(int pageSize)` Sets the size of a page for paging through results.
`QueryRequest<B>`	`sort(java.lang.String fieldName, SortDirection sortDirection)` Sets the sort expression for sorting the result.
`QueryRequest<B>`	`where(java.lang.String predicate)` Sets the predicate used to filter the results for this query request.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
 - QueryRequestMapping
```
protected QueryRequestMapping(QueryRequest<A> delegate)
```
- Method Detail
 - fetch
```
public final QueryResult fetch()
```
 Description copied from interface: QueryRequest
 
 Executes the request and returns the result.
 
 Specified by:
 
 fetch in interface QueryRequest
 - fetchAsync
```
public com.google.common.util.concurrent.ListenableFuture<QueryResult> fetchAsync()
```
 Description copied from interface: QueryRequest
 
 Executes the request asynchronously and returns a future providing the result.
 
 Specified by:
 
 fetchAsync in interface QueryRequest
 - convert
```
protected abstract B convert(A a)
```
 Override this method to convert elements from A to B.
 
 Parameters:
 a - The single element that should be converted to B.
 
 Returns:
 The converted a as B.
 - where
```
public QueryRequest where(java.lang.String predicate)
```
 Description copied from interface: QueryRequest
 
 Sets the predicate used to filter the results for this query request.
 Specified by:
 
 where in interface QueryRequest
 
 Parameters:
 predicate - The predicate which is used to filter the results. Example:
 "name(en=\"myName\")"
 .
 - sort
```
public QueryRequest sort(java.lang.String fieldName,
 SortDirection sortDirection)
```
 Description copied from interface: QueryRequest
 
 Sets the sort expression for sorting the result.
 Specified by:
 
 sort in interface QueryRequest
 
 Parameters:
 fieldName - the attribute to sort with Example:
 "name.en"
 .
 sortDirection - The direction to sort with.
 - page
```
public QueryRequest page(int page)
```
 Description copied from interface: QueryRequest
 
 Sets the page number for paging through results. Page numbers start at zero.
 
 Specified by:
 
 page in interface QueryRequest
 - pageSize
```
public QueryRequest pageSize(int pageSize)
```
 Description copied from interface: QueryRequest
 
 Sets the size of a page for paging through results. When page size is not set, the default of 10 is used.
 
 Specified by:
 
 pageSize in interface QueryRequest
 - expand
```
public QueryRequest expand(java.lang.String... paths)
```
 Description copied from interface: QueryRequest
 Requests Reference fields to be expanded in the returned objects. Expanded references contain full target objects they link to.
 As an illustration, here is how reference expansion looks at the underlying JSON transport level. Given a customer object:
```
{
 "name": "John Doe"
 "customerGroup": {
 "typeId": "customer-group",
 "id": "7ba61480-6a72-4a2a-a72e-cd39f75a7ef2"
 }
}
```
 This is what the result looks like when the path 'customerGroup' has been expanded:
```
{
 "name": "John Doe"
 "customerGroup": {
 typeId: "customer-group",
 id: "7ba61480-6a72-4a2a-a72e-cd39f75a7ef2"
 obj: {
 "name": "Gold"
 }
 }
}
```
 Specified by:
 
 expand in interface QueryRequest
 
 Parameters:
 paths - The paths to be expanded, such as 'customerGroup'.

Class QueryRequestMapping<A,B>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

QueryRequestMapping

Method Detail

fetch

fetchAsync

convert

where

sort

page

pageSize

expand