com.flowthings.client.api

Class DropApi

java.lang.Object

com.flowthings.client.api.DomainObjectApi<T>

com.flowthings.client.api.MutableDomainObjectApi<Drop>

com.flowthings.client.api.DropApi

public class DropApi
extends MutableDomainObjectApi<Drop>

See DomainObjectApi

Author:

matt

Field Summary

Fields inherited from class com.flowthings.client.api.DomainObjectApi

clazz

Method Summary

Modifier and Type	Method and Description
Request<Drop>	create(Drop t) Create a new object
Request<Drop>	delete(String id) Delete an object by ID
Request<Drop>	deleteAll() Remove all Drops from a Flow.
Request<List<Drop>>	find(QueryOptions queryOptions) Find multiple objects using search parameters
Request<Drop>	get(String id) Retrieve a single object by ID
Request<Drop>	subscribe(SubscriptionCallback<Drop> callback) Subscribe to a Flow.
Request<Drop>	unsubscribe()
Request<Drop>	update(String id, Drop t) Update an object with new attributes

Methods inherited from class com.flowthings.client.api.DomainObjectApi

find

Methods inherited from class java.lang.Object

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

Method Detail

get

public Request<Drop> get(String id)

Description copied from class: DomainObjectApi

Retrieve a single object by ID

Overrides:

get in class DomainObjectApi<Drop>

Parameters:

id - - the object's ID

Returns:

- A request object, to pass to an API

find

public Request<List<Drop>> find(QueryOptions queryOptions)

Description copied from class: DomainObjectApi

Find multiple objects using search parameters

Overrides:

find in class DomainObjectApi<Drop>

Parameters:

queryOptions - - search parameters

Returns:

- A request object, to pass to an API

create

public Request<Drop> create(Drop t)

Description copied from class: DomainObjectApi

Create a new object

Overrides:

create in class DomainObjectApi<Drop>

Parameters:

t - - the object to create

Returns:

- A request object, to pass to an API

update

public Request<Drop> update(String id,
                            Drop t)

Description copied from class: MutableDomainObjectApi

Update an object with new attributes

Overrides:

update in class MutableDomainObjectApi<Drop>

Parameters:

id - - the object's ID

t - - an object containing new values

Returns:

- A request object, to pass to an API

delete

public Request<Drop> delete(String id)

Description copied from class: DomainObjectApi

Delete an object by ID

Overrides:

delete in class DomainObjectApi<Drop>

Parameters:

id - - the object's ID

Returns:

- A request object, to pass to an API

deleteAll

public Request<Drop> deleteAll()

Remove all Drops from a Flow.

Returns:

- A request object, to pass to an API

subscribe

public Request<Drop> subscribe(SubscriptionCallback<Drop> callback)

Subscribe to a Flow. All Drops sent to that Flow will be pushed to the client

Parameters:

callback - - called each time a new Drop arrives

Returns:

- A request object, to pass to an API

unsubscribe

public Request<Drop> unsubscribe()

Returns:

- A request object, to pass to an API