Interface INote

All Superinterfaces:
IChangelogSupport, ICountingSupport, ICrudByIdSupport<VNote>, IItemChangelogSupport, IReadByIdSupport<VNote>, IRestoreCrudSupport<VNote>, IRestoreItemCrudSupport<VNote>, IRestoreSupport<VNote>, ISortingSupport
@Path("/notes/{containerUid}") public interface INote extends IChangelogSupport, IItemChangelogSupport, 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(ContainerQuery) to lookup all containers of specific type.

  • Method Details

    • all

      @GET List<ItemValue<VNote>> all() throws net.bluemind.core.api.fault.ServerFault
      List all Notes of a container
      Returns:
      All VNote of the container
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, VNote note) throws net.bluemind.core.api.fault.ServerFault
      Creates a new VNote entry.
      Parameters:
      uid - Unique entry UID
      note - VNote values
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") String uid, VNote note) throws net.bluemind.core.api.fault.ServerFault
      Modifies an existing VNote.
      Parameters:
      uid - Unique entry UID
      note - VNote values
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • getComplete

      @GET @Path("{uid}/complete") ItemValue<VNote> getComplete(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.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:
      net.bluemind.core.api.fault.ServerFault - common error object

    • multipleGet

      @POST @Path("_mget") List<ItemValue<VNote>> multipleGet(List<String> uids) throws net.bluemind.core.api.fault.ServerFault
      Fetch multiple VNotes by their unique UIDs
      Parameters:
      uids - list of unique UIDs
      Returns:
      list of ItemValues containing VNotes
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • delete

      @DELETE @Path("{uid}") void delete(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Delete a VNote
      Specified by:
      delete in interface IRestoreCrudSupport<VNote>
      Parameters:
      uid - unique UID
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • reset

      @POST @Path("_reset") void reset() throws net.bluemind.core.api.fault.ServerFault
      Delete all VNotes of this user
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • updates

      @PUT @Path("_mupdates") ContainerUpdatesResult updates(VNoteChanges changes) throws net.bluemind.core.api.fault.ServerFault
      Updates multiple VNotes.
      Parameters:
      changes - VNoteChanges containing the requested updates
      Returns:
      ContainerUpdatesResult
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • allUids

      @GET @Path("_all") List<String> allUids() throws net.bluemind.core.api.fault.ServerFault
      Retrieve all VNote UIDs of this user
      Returns:
      List of UIDs
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • search

      @POST @Path("_search") net.bluemind.core.api.ListResult<ItemValue<VNote>> search(VNoteQuery query) throws net.bluemind.core.api.fault.ServerFault
      Search VNote's by VNoteQuery
      Parameters:
      query - VNoteQuery
      Returns:
      ListResult of the matching ItemValues containing a VNote
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • exportAll

      @GET @Path("_exportall") net.bluemind.core.api.Stream exportAll() throws net.bluemind.core.api.fault.ServerFault
      Export all VNote from a notes container as json stream (VNote)
      Returns:
      Stream of VNote list.
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object
      See Also: