net.bluemind.notes.api

Interface INotes

All Known Implementing Classes:

NotesService

@Path(value="/notes")
public interface INotes

Notes list management API. See INoteUids 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 notes list container + auto-subscribe + set ALL necessary Access-Control-List entries
void	delete(java.lang.String uid) Delete a Notelist container and all containing VNotes
java.util.List<ItemContainerValue<VNote>>	search(VNotesQuery 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 notes list container + auto-subscribe + set ALL necessary Access-Control-List entries

Parameters:

uid - Unique UID according to INoteUids

descriptor - Notelist container

Throws:

ServerFault - common error object

delete

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

Delete a Notelist container and all containing VNotes

Parameters:

uid - Unique UID

Throws:

ServerFault - common error object

search

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

Returns a ListResult of ItemValues containing VEvents

Parameters:

query - VNotesQuery

Returns:

ListResult of ItemValues containing VEvents

Throws:

ServerFault - common error object