Package net.bluemind.notes.api

Interface INote

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VNote>, IReadByIdSupport<VNote>, IRestoreCrudSupport<VNote>, IRestoreItemCrudSupport<VNote>, IRestoreSupport<VNote>, ISortingSupport

@Path("/notes/{containerUid}")
public interface INote
extends IChangelogSupport, ICountingSupport, ICrudByIdSupport<VNote>, ISortingSupport, IRestoreItemCrudSupport<VNote>

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

Method Summary

Modifier and Type	Method	Description
List<ItemValue<VNote>>	all()	List all Notes of a container
List<String>	allUids()	Retrieve all VNote UIDs of this user
void	create(String uid, VNote note)	Creates a new VNote entry.
void	delete(String uid)	Delete a VNote
Stream	exportAll()	Export all VNote from a notes container as json stream (VNote)
ItemValue<VNote>	getComplete(String uid)	Fetch a VNote by its unique UID
List<ItemValue<VNote>>	multipleGet(List<String> uids)	Fetch multiple VNotes by their unique UIDs
void	reset()	Delete all VNotes of this user
ListResult<ItemValue<VNote>>	search(VNoteQuery query)	Search VNote's by VNoteQuery
void	update(String uid, VNote note)	Modifies an existing VNote.
ContainerUpdatesResult	updates(VNoteChanges changes)	Updates multiple VNotes.

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

allIds, changeset, changesetById, filteredChangesetById, getVersion, itemChangelog

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

count

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

createById, deleteById, multipleDeleteById, multipleDeleteById, updateById

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

getCompleteById, multipleGetById

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

get, itemValueExists, restore

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

sortedIds

Method Details

all

@GET
List<ItemValue<VNote>> all()
                    throws ServerFault

List all Notes of a container

Returns:

All VNote of the container

Throws:

ServerFault - common error object

create

@PUT
@Path("{uid}")
void create(@PathParam("uid")
 String uid,
 VNote note)
     throws ServerFault

Creates a new VNote entry.

Parameters:

uid - Unique entry UID

note - VNote values

Throws:

ServerFault - common error object

update

@POST
@Path("{uid}")
void update(@PathParam("uid")
 String uid,
 VNote note)
     throws ServerFault

Modifies an existing VNote.

Parameters:

uid - Unique entry UID

note - VNote values

Throws:

ServerFault - common error object

getComplete

@GET
@Path("{uid}/complete")
ItemValue<VNote> getComplete(@PathParam("uid")
 String uid)
                      throws ServerFault

Fetch a VNote by its unique UID

Specified by:

getComplete in interface IRestoreItemCrudSupport<VNote>

Parameters:

uid - Unique entry UID

Returns:

ItemValue containing a VNote

Throws:

ServerFault - common error object

multipleGet

@POST
@Path("_mget")
List<ItemValue<VNote>> multipleGet(List<String> uids)
                            throws ServerFault

Fetch multiple VNotes by their unique UIDs

Parameters:

uids - list of unique UIDs

Returns:

list of ItemValues containing VNotes

Throws:

ServerFault - common error object

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)
     throws ServerFault

Delete a VNote

Specified by:

delete in interface IRestoreCrudSupport<VNote>

Parameters:

uid - unique UID

Throws:

ServerFault - common error object

reset

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

Delete all VNotes of this user

Throws:

ServerFault - common error object

updates

@PUT
@Path("_mupdates")
ContainerUpdatesResult updates(VNoteChanges changes)
                        throws ServerFault

Updates multiple VNotes.

Parameters:

changes - VNoteChanges containing the requested updates

Returns:

ContainerUpdatesResult

Throws:

ServerFault - common error object

allUids

@GET
@Path("_all")
List<String> allUids()
              throws ServerFault

Retrieve all VNote UIDs of this user

Returns:

List of UIDs

Throws:

ServerFault - common error object

search

@POST
@Path("_search")
ListResult<ItemValue<VNote>> search(VNoteQuery query)
                             throws ServerFault

Search VNote's by VNoteQuery

Parameters:

query - VNoteQuery

Returns:

ListResult of the matching ItemValues containing a VNote

Throws:

ServerFault - common error object

exportAll

@GET
@Path("_exportall")
Stream exportAll()
          throws ServerFault

Export all VNote from a notes container as json stream (VNote)

Returns:

Stream of VNote list.

Throws:

ServerFault - common error object