net.bluemind.todolist.api

Interface ITodoLists

All Known Implementing Classes:

TodoListsService

@Path(value="/todolists")
public interface ITodoLists

Todolist management API. See ITodoUids on how to create the unique UIDs.

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String uid, ContainerDescriptor descriptor) Create a todolist + auto-subscribe + set ALL necessary Access-Control-List entries
void	delete(java.lang.String uid) Delete a Todolist and all containing IVTodos
java.util.List<ItemContainerValue<VTodo>>	search(TodoListsVTodoQuery query) Returns a ListResult of ItemValues containing VEvents

Method Detail

create

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

Create a todolist + auto-subscribe + set ALL necessary Access-Control-List entries

Parameters:

uid - Unique UID according to ITodoUids

descriptor - Todolist values

Throws:

ServerFault - common error object

delete

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

Delete a Todolist and all containing IVTodos

Parameters:

uid - Unique UID

Throws:

ServerFault - common error object

search

@POST
 @Path(value="_search")
java.util.List<ItemContainerValue<VTodo>> search(TodoListsVTodoQuery query)
                                                                        throws ServerFault

Returns a ListResult of ItemValues containing VEvents

Parameters:

query - TodoListsVTodoQuery

Returns:

ListResult of ItemValues containing VEvents

Throws:

ServerFault - common error object