Package net.bluemind.notes.api

Interface INotes

@Path("/notes")
public interface INotes

Notes list management API. See INoteUids on how to create the unique UIDs.

Method Summary

Modifier and Type	Method	Description
void	create(String uid, ContainerDescriptor descriptor)	Create a notes list container + auto-subscribe + set ALL necessary Access-Control-List entries
void	delete(String uid)	Delete a Notelist container and all containing VNotes
List<ItemContainerValue<VNote>>	search(VNotesQuery query)	Returns a ListResult of ItemValues containing VNotes

Method Details

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 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("{uid}")
void delete(@PathParam("uid")
 String uid)
     throws ServerFault

Delete a Notelist container and all containing VNotes

Parameters:

uid - Unique UID

Throws:

ServerFault - common error object

search

@POST
@Path("_search")
List<ItemContainerValue<VNote>> search(VNotesQuery query)
                                throws ServerFault

Returns a ListResult of ItemValues containing VNotes

Parameters:

query - VNotesQuery

Returns:

ListResult of ItemValues containing VNotes

Throws:

ServerFault - common error object