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

Class PresetsRequestExecutor

java.lang.Object

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

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

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

public class PresetsRequestExecutor
extends PaginatedRequestExecutor<Presets>

Request executor provided by PresetsApi. Use this class if you want to fetch single preset through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.presets().fetch().execute();
   
 

Field Summary

Fields inherited from class com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor

eTag, maxResult, order, orderBy, query, startIndex

Constructor Summary

Constructors

Constructor and Description
PresetsRequestExecutor(PresetsService presetsService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
PresetsRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
PresetsRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
PresetsRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
PresetsRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
protected retrofit2.Call<Presets>	prepareCall() Prepares a request to execute.
PresetsRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.

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

params

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

execute, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

PresetsRequestExecutor

public PresetsRequestExecutor(PresetsService presetsService)

Constructs request executor initialized with corresponding service class.

Parameters:

presetsService - the presets API service.

Method Detail

startIndex

public PresetsRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Presets>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public PresetsRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Presets>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public PresetsRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Presets>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public PresetsRequestExecutor orderBy(OrderBy orderBy,
                                      Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Presets>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public PresetsRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Presets>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Presets> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Presets>

Returns:

the request.