net.bluemind.notes.api

Interface INote

All Superinterfaces:

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

All Known Implementing Classes:

NoteService

@Path(value="/notes/{containerUid}")
public interface INote
extends IChangelogSupport, ICountingSupport, ICrudByIdSupport<VNote>, ISortingSupport, IDataShardSupport, IRestoreCrudSupport<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 and Description
java.util.List<ItemValue<VNote>>	all() List all Notes of a container
java.util.List<java.lang.String>	allUids() Retrieve all VNote UIDs of this user
void	create(java.lang.String uid, VNote note) Creates a new VNote entry.
Ack	createById(long id, VNote value) Create a VNote
void	delete(java.lang.String uid) Delete a VNote
void	deleteById(long id) Delete a VNote
ItemValue<VNote>	getComplete(java.lang.String uid) Fetch a VNote by its unique UID
ItemValue<VNote>	getCompleteById(long id) Get ItemValue containing a VNote by its internal id
java.util.List<ItemValue<VNote>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VNotes by their unique UIDs
java.util.List<ItemValue<VNote>>	multipleGetById(java.util.List<java.lang.Long> ids) Fetch multiple VNotes by their unique IDs
void	reset() Delete all VNotes of this user
ListResult<ItemValue<VNote>>	search(VNoteQuery query) Search VNote's by VNoteQuery
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Get a sorted list (IDs according to the sorted list of items) of internal IDs
void	update(java.lang.String uid, VNote note) Modifies an existing VNote.
Ack	updateById(long id, VNote value) Update a VNote
ContainerUpdatesResult	updates(VNoteChanges changes) Updates multiple VNotes.

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

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

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

count

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

multipleDeleteById

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

xfer

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

get, restore

Method Detail

all

@GET
java.util.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(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.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(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.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(value="{uid}/complete")
ItemValue<VNote> getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)
                                                          throws ServerFault

Fetch a VNote by its unique UID

Parameters:

uid - Unique entry UID

Returns:

ItemValue containing a VNote

Throws:

ServerFault - common error object

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<VNote>> multipleGet(java.util.List<java.lang.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

multipleGetById

@POST
 @Path(value="_mgetById")
java.util.List<ItemValue<VNote>> multipleGetById(java.util.List<java.lang.Long> ids)
                                                                          throws ServerFault

Fetch multiple VNotes by their unique IDs

Specified by:

multipleGetById in interface IReadByIdSupport<VNote>

Parameters:

ids - list of unique IDs

Returns:

list of ItemValues containing VNotes

Throws:

ServerFault - common error object

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.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(value="_reset")
void reset()
                                 throws ServerFault

Delete all VNotes of this user

Throws:

ServerFault - common error object

updates

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

Updates multiple VNotes.

Parameters:

changes - VNoteChanges containing the requested updates

Returns:

ContainerUpdatesResult

Throws:

ServerFault - common error object

getCompleteById

@GET
 @Path(value="{id}/completeById")
ItemValue<VNote> getCompleteById(@PathParam(value="id")
                                                                        long id)

Get ItemValue containing a VNote by its internal id

Specified by:

getCompleteById in interface IReadByIdSupport<VNote>

Parameters:

id - internal id

Returns:

Matching ItemValue containing a VNote

updateById

@POST
 @Path(value="id/{id}")
Ack updateById(@PathParam(value="id")
                                             long id,
                                             VNote value)

Update a VNote

Specified by:

updateById in interface ICrudByIdSupport<VNote>

Parameters:

id - internal id

value - VNote

Returns:

Ack containing the new version number

createById

@PUT
 @Path(value="id/{id}")
Ack createById(@PathParam(value="id")
                                            long id,
                                            VNote value)

Create a VNote

Specified by:

createById in interface ICrudByIdSupport<VNote>

Parameters:

id - internal id

value - VNote

Returns:

Ack containing the new version number

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

Delete a VNote

Specified by:

deleteById in interface ICrudByIdSupport<VNote>

Parameters:

id - internal id

allUids

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

Retrieve all VNote UIDs of this user

Returns:

List of UIDs

Throws:

ServerFault - common error object

sortedIds

@POST
 @Path(value="_sorted")
java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)
                                                                throws ServerFault

Get a sorted list (IDs according to the sorted list of items) of internal IDs

Specified by:

sortedIds in interface ISortingSupport

Parameters:

{@link - net.bluemind.core.container.model.SortDescriptor}

Returns:

List of internal IDs

Throws:

ServerFault - common error object

search

@POST
 @Path(value="_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