Interface ITodoList

All Superinterfaces:
IChangelogSupport, ICountingSupport, ICrudByIdSupport<VTodo>, IItemChangelogSupport, IReadByIdSupport<VTodo>, IRestoreCrudSupport<VTodo>, IRestoreItemCrudSupport<VTodo>, IRestoreSupport<VTodo>, ISortingSupport
@Path("/todolist/{containerUid}") public interface ITodoList extends IChangelogSupport, IItemChangelogSupport, ICountingSupport, ICrudByIdSupport<VTodo>, ISortingSupport, IRestoreItemCrudSupport<VTodo>
Todolist API. All methods work on Todos in a specific container identified by a unique UID, see ITodoUids. Use IContainers.all(ContainerQuery) to lookup all containers of specific type.

  • Method Details

    • all

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

    • create

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

    • update

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

    • getComplete

      @GET @Path("{uid}/complete") ItemValue<VTodo> getComplete(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Fetch a VTodo by its unique UID
      Specified by:
      getComplete in interface IRestoreItemCrudSupport<VTodo>
      Parameters:
      uid - Unique entry UID
      Returns:
      ItemValue containing a VTodo
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • multipleGet

      @POST @Path("_mget") List<ItemValue<VTodo>> multipleGet(List<String> uids) throws net.bluemind.core.api.fault.ServerFault
      Fetch multiple VTodos by their unique UIDs
      Parameters:
      uids - list of unique UIDs
      Returns:
      list of ItemValues containing VTodos
      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 VTodo
      Specified by:
      delete in interface IRestoreCrudSupport<VTodo>
      Parameters:
      uid - unique UID
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • search

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

    • multipleGetByRange

      @POST @Path("_mget_range") net.bluemind.core.api.ListResult<ItemValue<VTodo>> multipleGetByRange(VTodoRange range) throws net.bluemind.core.api.fault.ServerFault
      Fetch multiple VTodo identified by the given range
      Parameters:
      range - VTodoRange
      Returns:
      all matching VTodo
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • multipleGetWithOffset

      @GET @Path("_mget_offset") net.bluemind.core.api.ListResult<ItemValue<VTodo>> multipleGetWithOffset(@QueryParam("from") Integer from, @QueryParam("size") Integer size) throws net.bluemind.core.api.fault.ServerFault
      Index/Offset based GET
      Parameters:
      size - max number of elements requested
      offset - the database offset
      Returns:
      ListResult of all items matching the range
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • updates

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

    • sync

      @POST @Path("_sync") ContainerChangeset<String> sync(@QueryParam("since") Long since, VTodoChanges changes) throws net.bluemind.core.api.fault.ServerFault
      Client/Server synchronization of VTodos. Applies client changes and returns server updates happened since since parameter.
      Parameters:
      since - timestamp of the requested server updates
      changes - client updates
      Returns:
      ContainerChangeset containing the server updates
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • copy

      @POST @Path("_copy/{destContainerUid}") void copy(List<String> uids, @PathParam("destContainerUid") String descContainerUid) throws net.bluemind.core.api.fault.ServerFault
      Copy VTodos to another Todolist
      Parameters:
      uids - list of unique UIDs
      descContainerUid - the destination Todolist container UID
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • move

      @POST @Path("_move/{destContainerUid}") void move(List<String> uids, @PathParam("destContainerUid") String descContainerUid) throws net.bluemind.core.api.fault.ServerFault
      Move VTodos to another Todolist
      Parameters:
      uids - list of unique UIDs
      descContainerUid - the destination Todolist container 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 VTodos of this Todolist
      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 VTodo UIDs of this Todolist
      Returns:
      List of UIDs
      Throws:
      net.bluemind.core.api.fault.ServerFault - common error object

    • getByIcsUid

      @GET @Path("_icsuid/{uid}") List<ItemValue<VTodo>> getByIcsUid(@PathParam("uid") String uid) throws net.bluemind.core.api.fault.ServerFault
      Returns all VTodo matching the given ICS unique identifier.
      Parameters:
      uid - the ICS unique identifier
      Returns:
      the list of matching VTodo
      Throws:
      net.bluemind.core.api.fault.ServerFault