net.bluemind.todolist.api

Interface ITodoList

All Superinterfaces:

IChangelogSupport

All Known Implementing Classes:

TodoListService

@Path(value="/todolist/{containerUid}")
public interface ITodoList
extends IChangelogSupport

Todos APIs. Blue Mind provides client and server side implementations of this a unique UID, see ITodoUids. Use IContainers.all(net.bluemind.core.container.api.ContainerQuery) to lookup all interface.

Method Summary

Modifier and Type	Method and Description
java.util.List<ItemValue<VTodo>>	all() List all items from container
java.util.List<java.lang.String>	allUids() Returns all the items uid from the container
void	copy(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Copy entries from one Todo List to another one
void	create(java.lang.String uid, VTodo todo) Creates a new VTodo entry.
void	delete(java.lang.String uid) Delete VTodo entry
ItemValue<VTodo>	getComplete(java.lang.String uid) Fetch a VTodo from its unique uid
void	move(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Move entries from one Todo list to another one
java.util.List<ItemValue<VTodo>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VTodos from theirs uniques uids
void	reset()
ListResult<ItemValue<VTodo>>	search(VTodoQuery query) ElasticSearch based VTodo search
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VTodoChanges changes) Apply changes sent by client and return changes that happens on server since since parameter.
void	update(java.lang.String uid, VTodo todo) Modifies an existing VTodo entry.
ContainerUpdatesResult	updates(VTodoChanges changes) Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)

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

changeset, changesetById, containerChangelog, getVersion, itemChangelog

Method Detail

all

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

List all items from container

Returns:

All VTodo of the container

Throws:

ServerFault

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 - uid of the entry

todo - value of the entry

Throws:

ServerFault

update

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

Modifies an existing VTodo entry.

Parameters:

uid - uid of the entry

todo - value of the entry

Throws:

ServerFault

getComplete

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

Fetch a VTodo from its unique uid

Parameters:

uid -

Returns:

ItemValue

Throws:

ServerFault

multipleGet

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

Fetch multiple VTodos from theirs uniques uids

Parameters:

uids -

Returns:

List>

Throws:

ServerFault

delete

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

Delete VTodo entry

Parameters:

uid -

Throws:

ServerFault

search

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

ElasticSearch based VTodo search

Parameters:

query -

Returns:

Throws:

ServerFault

updates

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

Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)

Parameters:

changes -

Throws:

ServerFault

sync

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

Apply changes sent by client and return changes that happens on server since since parameter.

Parameters:

since -

changes -

Returns:

Throws:

ServerFault

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 entries from one Todo List to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

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 entries from one Todo list to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

reset

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

Throws:

ServerFault

allUids

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

Returns all the items uid from the container

Returns:

Throws:

ServerFault