com.evrythng.java.wrapper.service

Class CollectionService

java.lang.Object

com.evrythng.java.wrapper.core.EvrythngServiceBase

com.evrythng.java.wrapper.service.CollectionService

public class CollectionService
extends EvrythngServiceBase

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH_CHILD_COLLECTION
static String	PATH_CHILDREN_COLLECTIONS
static String	PATH_COLLECTION
static String	PATH_COLLECTION_THNG
static String	PATH_COLLECTION_THNGS
static String	PATH_COLLECTIONS
static String	PATH_COLLECTIONS_ACTIONS
static String	PATH_COLLECTIONS_TYPED_ACTION
static String	PATH_COLLECTIONS_TYPED_ACTIONS

Constructor Summary

Constructors

Constructor and Description
CollectionService(ApiManager apiManager)

Method Summary

Modifier and Type	Method and Description
<T extends Action> EvrythngApiBuilder.Builder<T>	actionCreator(String collectionId, T actionToCreate)
EvrythngApiBuilder.Builder<CustomAction>	actionReader(String collectionId, String customType, String actionId)
EvrythngApiBuilder.Builder<List<CustomAction>>	actionsReader(String collectionId, String customType)
protected void	checkCustomType(String customType)
EvrythngApiBuilder.Builder<Void>	childCollectionAdder(String collectionId, String childCollectionId) Adds child Collection matching the provided id to the provided Collection.
EvrythngApiBuilder.Builder<Boolean>	childCollectionRemover(String collectionId, String childCollectionId) Removes the provided child Collection from the provided Collection.
EvrythngApiBuilder.Builder<Void>	childrenCollectionsAdder(String collectionId, Set<String> childrenCollectionsId) Adds children Collections matching the provided ids to the provided Collection.
EvrythngApiBuilder.Builder<List<Collection>>	childrenCollectionsReader(String collectionId) Retrieves all children Collections for the provided Collection.
EvrythngApiBuilder.Builder<Boolean>	childrenCollectionsRemover(String collectionId) Removes all children Collections from the provided Collection.
EvrythngApiBuilder.Builder<Collection>	collectionCreator(Collection collection) Creates a new Collection.
EvrythngApiBuilder.Builder<Boolean>	collectionDeleter(String collectionId) Deletes the referenced Collection.
EvrythngApiBuilder.Builder<Collection>	collectionReader(String collectionId) Retrieves the referenced Collection.
EvrythngApiBuilder.Builder<List<Collection>>	collectionsReader() Retrieves the last updated Collection resources.
EvrythngApiBuilder.Builder<Collection>	collectionUpdater(String collectionId, Collection collection) Updates the referenced Collection.
EvrythngApiBuilder.Builder<Collection>	thngAdder(String collectionId, String thngId) Adds the referenced Thng to the provided Collection.
EvrythngApiBuilder.Builder<Boolean>	thngRemover(String collectionId, String thngId) Removes the referenced Thng from the provided Collection.
EvrythngApiBuilder.Builder<Collection>	thngsAdder(String collectionId, List<String> thngs) Adds the referenced Thng resources to the provided Collection.
EvrythngApiBuilder.Builder<List<Thng>>	thngsReader(String collectionId) Retrieves the last updated Thng resources linked with the referenced Collection.
EvrythngApiBuilder.Builder<Boolean>	thngsRemover(String collectionId) Removes all Thng resources from the provided Collection.

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_COLLECTIONS

public static final String PATH_COLLECTIONS

See Also:

Constant Field Values

PATH_COLLECTION

public static final String PATH_COLLECTION

See Also:

Constant Field Values

PATH_COLLECTION_THNGS

public static final String PATH_COLLECTION_THNGS

See Also:

Constant Field Values

PATH_COLLECTION_THNG

public static final String PATH_COLLECTION_THNG

See Also:

Constant Field Values

PATH_COLLECTIONS_ACTIONS

public static final String PATH_COLLECTIONS_ACTIONS

See Also:

Constant Field Values

PATH_COLLECTIONS_TYPED_ACTIONS

public static final String PATH_COLLECTIONS_TYPED_ACTIONS

See Also:

Constant Field Values

PATH_COLLECTIONS_TYPED_ACTION

public static final String PATH_COLLECTIONS_TYPED_ACTION

See Also:

Constant Field Values

PATH_CHILDREN_COLLECTIONS

public static final String PATH_CHILDREN_COLLECTIONS

See Also:

Constant Field Values

PATH_CHILD_COLLECTION

public static final String PATH_CHILD_COLLECTION

See Also:

Constant Field Values

Constructor Detail

CollectionService

public CollectionService(ApiManager apiManager)

Method Detail

collectionCreator

public EvrythngApiBuilder.Builder<Collection> collectionCreator(Collection collection)
                                                         throws EvrythngClientException

Creates a new Collection.

POST "/collections"

Parameters:

collection - the instant holding the Collection resource data

Returns:

a Collection creator

Throws:

EvrythngClientException

collectionsReader

public EvrythngApiBuilder.Builder<List<Collection>> collectionsReader()
                                                               throws EvrythngClientException

Retrieves the last updated Collection resources.

GET "/collections"

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

collectionReader

public EvrythngApiBuilder.Builder<Collection> collectionReader(String collectionId)
                                                        throws EvrythngClientException

Retrieves the referenced Collection.

GET "/collections/%s"

Parameters:

collectionId - collection id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

collectionUpdater

public EvrythngApiBuilder.Builder<Collection> collectionUpdater(String collectionId,
                                                                Collection collection)
                                                         throws EvrythngClientException

Updates the referenced Collection.

PUT "/collections/%s"

Parameters:

collectionId - collection id

collection - Collection instance

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

collectionDeleter

public EvrythngApiBuilder.Builder<Boolean> collectionDeleter(String collectionId)
                                                      throws EvrythngClientException

Deletes the referenced Collection.

DELETE "/collections/%s"

Parameters:

collectionId - collection id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngsReader

public EvrythngApiBuilder.Builder<List<Thng>> thngsReader(String collectionId)
                                                   throws EvrythngClientException

Retrieves the last updated Thng resources linked with the referenced Collection.

GET "/collections/%s/thngs"

Parameters:

collectionId - collection id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngAdder

public EvrythngApiBuilder.Builder<Collection> thngAdder(String collectionId,
                                                        String thngId)
                                                 throws EvrythngClientException

Adds the referenced Thng to the provided Collection.

PUT "/collections/%s/thngs"

Parameters:

collectionId - collection id

thngId - thng id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

See Also:

thngsAdder(String, List)

thngsAdder

public EvrythngApiBuilder.Builder<Collection> thngsAdder(String collectionId,
                                                         List<String> thngs)
                                                  throws EvrythngClientException

Adds the referenced Thng resources to the provided Collection.

PUT "/collections/%s/thngs"

Parameters:

collectionId - collection id

thngs - list of thng ids

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngRemover

public EvrythngApiBuilder.Builder<Boolean> thngRemover(String collectionId,
                                                       String thngId)
                                                throws EvrythngClientException

Removes the referenced Thng from the provided Collection.

DELETE "/collections/%s/thngs/%s"

Parameters:

collectionId - collection id

thngId - thng id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

thngsRemover

public EvrythngApiBuilder.Builder<Boolean> thngsRemover(String collectionId)
                                                 throws EvrythngClientException

Removes all Thng resources from the provided Collection.

DELETE "/collections/%s/thngs"

Parameters:

collectionId - collection id

Returns:

a preconfigured EvrythngApiBuilder.Builder

Throws:

EvrythngClientException

checkCustomType

protected void checkCustomType(String customType)

actionCreator

public <T extends Action> EvrythngApiBuilder.Builder<T> actionCreator(String collectionId,
                                                                      T actionToCreate)
                                                               throws EvrythngClientException

Throws:

EvrythngClientException

actionReader

public EvrythngApiBuilder.Builder<CustomAction> actionReader(String collectionId,
                                                             String customType,
                                                             String actionId)
                                                      throws EvrythngClientException

Throws:

EvrythngClientException

actionsReader

public EvrythngApiBuilder.Builder<List<CustomAction>> actionsReader(String collectionId,
                                                                    String customType)
                                                             throws EvrythngClientException

Throws:

EvrythngClientException

childrenCollectionsRemover

public EvrythngApiBuilder.Builder<Boolean> childrenCollectionsRemover(String collectionId)
                                                               throws EvrythngClientException

Removes all children Collections from the provided Collection.

DELETE "/collections/%s/collections"

Throws:

EvrythngClientException

childCollectionRemover

public EvrythngApiBuilder.Builder<Boolean> childCollectionRemover(String collectionId,
                                                                  String childCollectionId)
                                                           throws EvrythngClientException

Removes the provided child Collection from the provided Collection.

DELETE "/collections/%s/collections/%s"

Throws:

EvrythngClientException

childrenCollectionsAdder

public EvrythngApiBuilder.Builder<Void> childrenCollectionsAdder(String collectionId,
                                                                 Set<String> childrenCollectionsId)
                                                          throws EvrythngClientException

Adds children Collections matching the provided ids to the provided Collection.

POST "/collections/%s/collections"

Throws:

EvrythngClientException

childCollectionAdder

public EvrythngApiBuilder.Builder<Void> childCollectionAdder(String collectionId,
                                                             String childCollectionId)
                                                      throws EvrythngClientException

Adds child Collection matching the provided id to the provided Collection.

POST "/collections/%s/collections"

Throws:

EvrythngClientException

childrenCollectionsReader

public EvrythngApiBuilder.Builder<List<Collection>> childrenCollectionsReader(String collectionId)
                                                                       throws EvrythngClientException

Retrieves all children Collections for the provided Collection.

GET "/collections/%s/collections"

Throws:

EvrythngClientException