Interface IAddressBook

All Superinterfaces:
IChangelogSupport, ICountingSupport, ICrudByIdSupport<VCard>, IGetSupport<VCard>, IItemChangelogSupport, IReadByIdSupport<VCard>, IRestoreCrudSupport<VCard>, IRestoreItemCrudSupport<VCard>, IRestoreSupport<VCard>, ISortingSupport
@Path("/addressbooks/{containerUid}") public interface IAddressBook extends IChangelogSupport, IItemChangelogSupport, ICrudByIdSupport<VCard>, ICountingSupport, ISortingSupport, IRestoreItemCrudSupport<VCard>, IGetSupport<VCard>
Addressbooks APIs. BlueMind provides client and server side implementations of this interface.

  • Method Details

    • allUids

      @GET @Path("_all") List<String> allUids()
      List all items from container
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • create

      @PUT @Path("{uid}") void create(@PathParam("uid") String uid, VCard card)
      Creates a new VCard entry.
      Parameters:
      uid - uid of the entry
      card - value of the entry
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • update

      @POST @Path("{uid}") void update(@PathParam("uid") String uid, VCard card)
      Modifies an existing VCard entry.
      Parameters:
      uid - uid of the entry
      card - value of the entry
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getComplete

      @GET @Path("{uid}/complete") ItemValue<VCard> getComplete(@PathParam("uid") String uid)
      Fetch a VCard from its unique uid
      Specified by:
      getComplete in interface IGetSupport<VCard>
      Specified by:
      getComplete in interface IRestoreItemCrudSupport<VCard>
      Parameters:
      uid -
      Returns:
      ItemValue<VCard>
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getLight

      @GET @Path("{uid}/_light") ItemValue<VCard> getLight(@PathParam("uid") String uid)
      Specified by:
      getLight in interface IGetSupport<VCard>

    • multipleGet

      @POST @Path("_mget") List<ItemValue<VCard>> multipleGet(List<String> uids)
      Fetch multiple VCards from theirs uniques uids
      Parameters:
      uids -
      Returns:
      List<ItemValue<VCard>>
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • getInfo

      @GET @Path("{uid}/info") ItemValue<VCardInfo> getInfo(@PathParam("uid") String uid)
      Fetch a VCardInfo from its unique uid
      Parameters:
      uid -
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • delete

      @DELETE @Path("{uid}") void delete(@PathParam("uid") String uid)
      Delete vcard entry
      Specified by:
      delete in interface IRestoreCrudSupport<VCard>
      Parameters:
      uid -
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • range

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

    • search

      @POST @Path("_search") net.bluemind.core.api.ListResult<ItemValue<VCardInfo>> search(VCardQuery query)
      ElasticSearch based vcard search
      Parameters:
      query - the vcard search query
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • updates

      @PUT @Path("_mupdates") ContainerUpdatesResult updates(VCardChanges changes)
      Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)
      Parameters:
      changes -
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • sync

      @POST @Path("_sync") ContainerChangeset<String> sync(@QueryParam("since") Long since, VCardChanges changes)
      CLIENT_WIN style
      Parameters:
      since -
      changes -
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • setPhoto

      @POST @Path("{uid}/photo") void setPhoto(@PathParam("uid") String uid, byte[] photo)

    • getPhoto

      @GET @Path("{uid}/photo") @Produces("image/png") byte[] getPhoto(@PathParam("uid") String uid)

    • deletePhoto

      @DELETE @Path("{uid}/photo") void deletePhoto(@PathParam("uid") String uid)

    • getIcon

      @GET @Path("{uid}/icon") @Produces("image/png") byte[] getIcon(@PathParam("uid") String uid)
      A scaled-down (22px x 22px) version of the photo
      Parameters:
      uid -
      Returns:
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • copy

      @POST @Path("_copy/{destContainerUid}") void copy(List<String> uids, @PathParam("destContainerUid") String descContainerUid)
      Copy entries from one AddressBook to another one. A copy keeps the uid of its entry, unless the destination already holds an entry with this uid: the copy then gets a new uid.
      Parameters:
      uids -
      descContainerUid -
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • move

      @POST @Path("_move/{destContainerUid}") void move(List<String> uids, @PathParam("destContainerUid") String descContainerUid)
      Move entries from one AddressBook to another one. A moved entry keeps its uid and overwrites the entry with the same uid in the destination, photo included. Moving entries to their own AddressBook does nothing.
      Parameters:
      uids -
      descContainerUid -
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • reset

      @POST @Path("_reset") void reset()
      Throws:
      net.bluemind.core.api.fault.ServerFault

    • touch

      @POST @Path("{uid}/_touch") void touch(String uid)
      Touch a VCard.
      Parameters:
      uid - the unique identifier of the vcard