Interface ITags

All Superinterfaces:
IRestoreCrudSupport<Tag>, IRestoreItemCrudSupport<Tag>, IRestoreSupport<Tag>
@Path("/tags/{containerUid}") public interface ITags extends IRestoreItemCrudSupport<Tag>
This API is used to manage per-user invalid input: '&' per-domain lists of Tag (keyword and color). The containerUid is obtained from ITagUids.getDefaultUserTags(String) or can be a domain uid (ie. domain name).

  • Method Details

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, Tag tag)
      Create a new Tag. Tags can be associated with items and may be used to categorize items or for searching.
      Parameters:
      uid - The unique identifier
      tag - Tag that will be created.
      Throws:
      ServerFault - If anything goes wrong

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") String uid, Tag tag)
      Update a Tag.
      Parameters:
      uid - The unique identifier
      tag - Tag that will be created.
      Throws:
      ServerFault - If anything goes wrong

    • delete

      @DELETE @Path("{uid}") void delete(@PathParam("uid") String uid)
      Delete a Tag.
      Specified by:
      delete in interface IRestoreCrudSupport<Tag>
      Parameters:
      uid - The unique identifier of the Tag
      tag - Tag that will be created.
      Throws:
      ServerFault - If anything goes wrong

    • getComplete

      @GET @Path("{uid}") ItemValue<Tag> getComplete(@PathParam("uid") String uid)
      Fetch a Tag from its uid.
      Specified by:
      getComplete in interface IRestoreItemCrudSupport<Tag>
      Parameters:
      uid - The unique identifier
      Returns:
      ItemValue<Tag>
      Throws:
      ServerFault - If anything goes wrong

    • multipleGet

      @POST @Path("_mget") List<ItemValue<Tag>> multipleGet(List<String> uids)
      Fetch multiple Tags from their uids.
      Parameters:
      uids - the unique identifiers to fetch
      Returns:
      a list of ItemValue<Tag>
      Throws:
      ServerFault - If anything goes wrong

    • all

      @GET List<ItemValue<Tag>> all()
      Find all Tags. Domain tags are not returned when this method is invoked on ITagUids.defaultTags(String).
      Returns:
      list of Tags
      Throws:
      ServerFault - If anything goes wrong

    • updates

      @PUT @Path("_mupdates") ContainerUpdatesResult updates(TagChanges changes)
      Update multiple tags at once.
      Parameters:
      changes - the batch of changes to apply
      Throws:
      ServerFault - If anything goes wrong

    • changeset

      @GET @Path("_changeset") ContainerChangeset<String> changeset(@QueryParam("since") Long since)
      ContainerChangeset of the container starting at given version.
      Parameters:
      since - version of first change to retrieve
      Throws:
      ServerFault - If anything goes wrong

    • allUids

      @GET @Path("_alluids") List<String> allUids()
      List all Tag uids in the container.
      Returns:
      a list of Tag uid
      Throws:
      ServerFault - If anything goes wrong