com.evrythng.java.wrapper.service

Class PlaceService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.PlaceService

public class PlaceService
extends EvrythngServiceBase

Service wrapper for the /places endpoint of the EVRYTHNG API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_PLACE
static String	PATH_PLACES

Constructor Summary

Constructors

Constructor and Description
PlaceService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
EvrythngApiBuilder.Builder<Place>	placeCreator(Place place) Creates a new Place.
EvrythngApiBuilder.Builder<Boolean>	placeDeleter(String placeId) Deletes the referenced Place.
EvrythngApiBuilder.Builder<Place>	placeReader(String placeId) Retrieves the referenced Place.
EvrythngApiBuilder.Builder<List<Place>>	placesReader() Retrieves list of all Place resources.
EvrythngApiBuilder.Builder<Place>	placeUpdater(String placeId, Place place) Updates the referenced Place.

Methods inherited from class com.evrythng.java.wrapper.core.EvrythngServiceBase

absoluteUri, delete, deleteMultiple, encodeBase64, get, getConfig, iterator, mqttUrl, onBuilderCreated, post, post, postAsynchronously, postMultipart, postMultipart, put, put, putMultipart, putMultipart, putMultiple, urlEncodePathPart

Methods inherited from class java.lang.Object

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

Field Detail

PATH_PLACES

public static final String PATH_PLACES

See Also:

Constant Field Values

PATH_PLACE

public static final String PATH_PLACE

See Also:

Constant Field Values

Constructor Detail

PlaceService

public PlaceService(ApiManager apiManager)

Parameters:

apiManager - ApiManager instance

Method Detail

placeCreator

public EvrythngApiBuilder.Builder<Place> placeCreator(Place place)
                                               throws EvrythngClientException

Creates a new Place.

POST "/places"

Parameters:

place - Place instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

placesReader

public EvrythngApiBuilder.Builder<List<Place>> placesReader()
                                                     throws EvrythngClientException

Retrieves list of all Place resources.

GET "/places"

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

placeReader

public EvrythngApiBuilder.Builder<Place> placeReader(String placeId)
                                              throws EvrythngClientException

Retrieves the referenced Place.

GET "/places/%s"

Parameters:

placeId - place id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

placeUpdater

public EvrythngApiBuilder.Builder<Place> placeUpdater(String placeId,
                                                      Place place)
                                               throws EvrythngClientException

Updates the referenced Place.

PUT "/places/%s"

Parameters:

placeId - place id

place - Place instance

Returns:

the updated place

Throws:

EvrythngClientException

placeDeleter

public EvrythngApiBuilder.Builder<Boolean> placeDeleter(String placeId)
                                                 throws EvrythngClientException

Deletes the referenced Place.

DELETE "/places/%s"

Parameters:

placeId - place id

Returns:

true if the place was successfully removed, otherwise false

Throws:

EvrythngClientException