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

Class PlacesRequestExecutor

java.lang.Object

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

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

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

public class PlacesRequestExecutor
extends PaginatedRequestExecutor<Places>

Request executor provided by PlacesApi. Use this class if you want to obtain places through fluent API in chained fashion, for instance:

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   Places places = kontaktCloud.places().fetch()
      .fromVenues(venueIds)
      .maxResult(20)
      .execute();
   
 

Constructor Summary

Constructors

Constructor and Description
PlacesRequestExecutor(PlacesService placesService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
PlacesRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
PlacesRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
PlacesRequestExecutor	fromVenues(java.util.List<java.util.UUID> venueIds) Specifies venues for whose places belong to.
PlacesRequestExecutor	fromVenues(java.util.UUID... venueIds) Specifies venues for whose places belong to.
PlacesRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
PlacesRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
PlacesRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
PlacesRequestExecutor	withIds(java.util.List<java.util.UUID> ids) Specifies places identifiers.
PlacesRequestExecutor	withIds(java.util.UUID... ids) Specifies places identifiers.

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

execute, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

PlacesRequestExecutor

public PlacesRequestExecutor(PlacesService placesService)

Constructs request executor initialized with corresponding service class.

Parameters:

placesService - the places API service.

Method Detail

withIds

public PlacesRequestExecutor withIds(java.util.UUID... ids)

Specifies places identifiers. Use that method if you want to fetch particular place by ID.

Parameters:

ids - places identifiers.

Returns:

this request executor.

withIds

public PlacesRequestExecutor withIds(java.util.List<java.util.UUID> ids)

Specifies places identifiers. Use that method if you want to fetch particular place by ID.

Parameters:

ids - places identifiers.

Returns:

this request executor.

fromVenues

public PlacesRequestExecutor fromVenues(java.util.UUID... venueIds)

Specifies venues for whose places belong to.

Parameters:

venueIds - venues identifiers.

Returns:

this request executor.

fromVenues

public PlacesRequestExecutor fromVenues(java.util.List<java.util.UUID> venueIds)

Specifies venues for whose places belong to.

Parameters:

venueIds - venues identifiers.

Returns:

this request executor.

startIndex

public PlacesRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Places>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public PlacesRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Places>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public PlacesRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Places>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public PlacesRequestExecutor orderBy(OrderBy orderBy,
                                     Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Places>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public PlacesRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Places>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.