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

Class ManagersRequestExecutor

java.lang.Object

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

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

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

public class ManagersRequestExecutor
extends PaginatedRequestExecutor<Managers>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Managers managers = kontaktCloud.managers().fetch()
      .subordinatesOf(supervisorID)
      .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
ManagersRequestExecutor(ManagersService managersService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ManagersRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
ManagersRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ManagersRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ManagersRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
protected retrofit2.Call<Managers>	prepareCall() Prepares a request to execute.
ManagersRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
ManagersRequestExecutor	subordinatesOf(java.util.UUID managerId) We can use this method if we want to fetch all subordinate managers for the given manager.

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

ManagersRequestExecutor

public ManagersRequestExecutor(ManagersService managersService)

Constructs request executor initialized with corresponding service class.

Parameters:

managersService - the managers API service.

Method Detail

subordinatesOf

public ManagersRequestExecutor subordinatesOf(java.util.UUID managerId)

We can use this method if we want to fetch all subordinate managers for the given manager.

Parameters:

managerId - the manager's unique identifier.

Returns:

this request executor.

startIndex

public ManagersRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Managers>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ManagersRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Managers>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ManagersRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Managers>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ManagersRequestExecutor orderBy(OrderBy orderBy,
                                       Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Managers>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ManagersRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Managers>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Managers> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Managers>

Returns:

the request.