net.bluemind.todolist.api

Interface ITodoList

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VTodo>, IDataShardSupport, ISortingSupport

All Known Implementing Classes:

TodoListService

@Path(value="/todolist/{containerUid}")
public interface ITodoList
extends IChangelogSupport, ICountingSupport, ICrudByIdSupport<VTodo>, ISortingSupport, IDataShardSupport

Todolist API. All methods work on Todos in a specific container identified by a unique UID, see ITodoUids. Use IContainers.all(net.bluemind.core.container.api.ContainerQuery) to lookup all containers of specific type.

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<VTodo>>	all() List all Tasks of a Todolist container
java.util.List<java.lang.String>	allUids() Retrieve all VTodo UIDs of this Todolist
void	copy(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Copy VTodos to another Todolist
void	create(java.lang.String uid, VTodo todo) Creates a new VTodo entry.
Ack	createById(long id, VTodo value) Create a VTodo
void	delete(java.lang.String uid) Delete a VTodo
void	deleteById(long id) Delete a VTodo
ItemValue<VTodo>	getComplete(java.lang.String uid) Fetch a VTodo by its unique UID
ItemValue<VTodo>	getCompleteById(long id) Get ItemValue containing a VTodo by its internal id
void	move(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Move VTodos to another Todolist
java.util.List<ItemValue<VTodo>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VTodos by their unique UIDs
java.util.List<ItemValue<VTodo>>	multipleGetById(java.util.List<java.lang.Long> ids) Fetch multiple VTodos by their unique IDs
void	reset() Delete all VTodos of this Todolist
ListResult<ItemValue<VTodo>>	search(VTodoQuery query) Search VTodo's by VTodoQuery
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Get a sorted list (IDs according to the sorted list of items) of internal IDs
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VTodoChanges changes) Client/Server synchronization of VTodos.
void	update(java.lang.String uid, VTodo todo) Modifies an existing VTodo.
Ack	updateById(long id, VTodo value) Update a VTodo
ContainerUpdatesResult	updates(VTodoChanges changes) Updates multiple VTodos.

Methods inherited from interface net.bluemind.core.container.api.IChangelogSupport

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

Methods inherited from interface net.bluemind.core.container.api.ICountingSupport

count

Methods inherited from interface net.bluemind.core.container.api.ICrudByIdSupport

multipleDeleteById

Methods inherited from interface net.bluemind.core.container.api.IDataShardSupport

xfer

Method Detail

all

@GET
java.util.List<ItemValue<VTodo>> all()
                                   throws ServerFault

List all Tasks of a Todolist container

Returns:

All VTodo of the container

Throws:

ServerFault - common error object

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       VTodo todo)
                                throws ServerFault

Creates a new VTodo entry.

Parameters:

uid - Unique entry UID

todo - VTodo values

Throws:

ServerFault - common error object

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        VTodo todo)
                                 throws ServerFault

Modifies an existing VTodo.

Parameters:

uid - Unique entry UID

todo - VTodo values

Throws:

ServerFault - common error object

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<VTodo> getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)
                                                          throws ServerFault

Fetch a VTodo by its unique UID

Parameters:

uid - Unique entry UID

Returns:

ItemValue containing a VTodo

Throws:

ServerFault - common error object

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<VTodo>> multipleGet(java.util.List<java.lang.String> uids)
                                                                  throws ServerFault

Fetch multiple VTodos by their unique UIDs

Parameters:

uids - list of unique UIDs

Returns:

list of ItemValues containing VTodos

Throws:

ServerFault - common error object

multipleGetById

@POST
 @Path(value="_mgetById")
java.util.List<ItemValue<VTodo>> multipleGetById(java.util.List<java.lang.Long> ids)
                                                                          throws ServerFault

Fetch multiple VTodos by their unique IDs

Parameters:

ids - list of unique IDs

Returns:

list of ItemValues containing VTodos

Throws:

ServerFault - common error object

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Delete a VTodo

Parameters:

uid - unique UID

Throws:

ServerFault - common error object

search

@POST
 @Path(value="_search")
ListResult<ItemValue<VTodo>> search(VTodoQuery query)
                                                           throws ServerFault

Search VTodo's by VTodoQuery

Parameters:

query - VTodoQuery

Returns:

ListResult of the matching ItemValues containing a VTodo

Throws:

ServerFault - common error object

updates

@PUT
 @Path(value="_mupdates")
ContainerUpdatesResult updates(VTodoChanges changes)
                                                       throws ServerFault

Updates multiple VTodos.

Parameters:

changes - VTodoChanges containing the requested updates

Returns:

ContainerUpdatesResult

Throws:

ServerFault - common error object

sync

@POST
 @Path(value="_sync")
ContainerChangeset<java.lang.String> sync(@QueryParam(value="since")
                                                                      java.lang.Long since,
                                                                      VTodoChanges changes)
                                                               throws ServerFault

Client/Server synchronization of VTodos. Applies client changes and returns server updates happened since since parameter.

Parameters:

since - timestamp of the requested server updates

changes - client updates

Returns:

ContainerChangeset containing the server updates

Throws:

ServerFault - common error object

copy

@POST
 @Path(value="_copy/{destContainerUid}")
void copy(java.util.List<java.lang.String> uids,
                                                         @PathParam(value="destContainerUid")
                                                         java.lang.String descContainerUid)
                                                  throws ServerFault

Copy VTodos to another Todolist

Parameters:

uids - list of unique UIDs

descContainerUid - the destination Todolist container UID

Throws:

ServerFault - common error object

move

@POST
 @Path(value="_move/{destContainerUid}")
void move(java.util.List<java.lang.String> uids,
                                                         @PathParam(value="destContainerUid")
                                                         java.lang.String descContainerUid)
                                                  throws ServerFault

Move VTodos to another Todolist

Parameters:

uids - list of unique UIDs

descContainerUid - the destination Todolist container UID

Throws:

ServerFault - common error object

reset

@POST
 @Path(value="_reset")
void reset()
                                 throws ServerFault

Delete all VTodos of this Todolist

Throws:

ServerFault - common error object

getCompleteById

@GET
 @Path(value="{id}/completeById")
ItemValue<VTodo> getCompleteById(@PathParam(value="id")
                                                                        long id)

Get ItemValue containing a VTodo by its internal id

Specified by:

getCompleteById in interface ICrudByIdSupport<VTodo>

Parameters:

id - internal id

Returns:

Matching ItemValue containing a VTodo

updateById

@POST
 @Path(value="id/{id}")
Ack updateById(@PathParam(value="id")
                                             long id,
                                             VTodo value)

Update a VTodo

Specified by:

updateById in interface ICrudByIdSupport<VTodo>

Parameters:

id - internal id

value - VTodo

Returns:

Ack containing the new version number

createById

@PUT
 @Path(value="id/{id}")
Ack createById(@PathParam(value="id")
                                            long id,
                                            VTodo value)

Create a VTodo

Specified by:

createById in interface ICrudByIdSupport<VTodo>

Parameters:

id - internal id

value - VTodo

Returns:

Ack containing the new version number

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

Delete a VTodo

Specified by:

deleteById in interface ICrudByIdSupport<VTodo>

Parameters:

id - internal id

allUids

@GET
 @Path(value="_all")
java.util.List<java.lang.String> allUids()
                                                            throws ServerFault

Retrieve all VTodo UIDs of this Todolist

Returns:

List of UIDs

Throws:

ServerFault - common error object

sortedIds

@POST
 @Path(value="_sorted")
java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)
                                                                throws ServerFault

Get a sorted list (IDs according to the sorted list of items) of internal IDs

Specified by:

sortedIds in interface ISortingSupport

Parameters:

{@link - net.bluemind.core.container.model.SortDescriptor}

Returns:

List of internal IDs

Throws:

ServerFault - common error object