com.kontakt.sdk.android.cloud.api.executor

Class PaginatedRequestExecutor<T>

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<T>

com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor<T>

Type Parameters:

T - the response type.

Direct Known Subclasses:

ActionsRequestExecutor, CommandsRequestExecutor, ConfigsRequestExecutor, CredentialsListRequestExecutor, DevicesRequestExecutor, EddystonesRequestExecutor, FirmwaresRequestExecutor, IBeaconsRequestExecutor, ManagersRequestExecutor, NamespacesRequestExecutor, PresetsRequestExecutor, ProximitiesRequestExecutor, SecureConfigsRequestExecutor, VenuesRequestExecutor

public abstract class PaginatedRequestExecutor<T>
extends RequestExecutor<T>

Fluent API for building requests associated with paginated data.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	eTag
protected int	maxResult
protected java.lang.String	order
protected java.lang.String	orderBy
protected java.lang.String	query
protected int	startIndex

Constructor Summary

Constructors

Constructor and Description
PaginatedRequestExecutor()

Method Summary

Modifier and Type	Method and Description
PaginatedRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
PaginatedRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
PaginatedRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
PaginatedRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's query parameters in map.
PaginatedRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.

Methods inherited from class com.kontakt.sdk.android.cloud.api.executor.RequestExecutor

execute, execute, prepareCall

Methods inherited from class java.lang.Object

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

Field Detail

startIndex

protected int startIndex

maxResult

protected int maxResult

query

protected java.lang.String query

orderBy

protected java.lang.String orderBy

order

protected java.lang.String order

eTag

protected java.lang.String eTag

Constructor Detail

PaginatedRequestExecutor

public PaginatedRequestExecutor()

Method Detail

startIndex

public PaginatedRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public PaginatedRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public PaginatedRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public PaginatedRequestExecutor orderBy(OrderBy orderBy,
                                        Order order)

Specifies the ordering of response data elements.

Parameters:

orderBy - the field type that specifies the order by column.

order - ascending or descending.

Returns:

this request executor.

eTag

public PaginatedRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Composes the request's query parameters in map.

Specified by:

params in class RequestExecutor<T>

Returns:

the map of request parameters that are being used to get desired data from API.