net.bluemind.addressbook.api

Interface IAddressBook

All Superinterfaces:

IChangelogSupport

All Known Subinterfaces:

IInCoreAddressBook

All Known Implementing Classes:

AddressBookService

@Path(value="/addressbooks/{containerUid}")
public interface IAddressBook
extends IChangelogSupport

Addressbooks APIs. BlueMind provides client and server side implementations of this interface.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allUids() List all items from container
void	copy(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Copy entries from one AddressBook to another one
void	create(java.lang.String uid, VCard card) Creates a new VCard entry.
void	createById(long id, VCard card)
void	delete(java.lang.String uid) Delete vcard entry
void	deletePhoto(java.lang.String uid)
ItemValue<VCard>	getComplete(java.lang.String uid) Fetch a VCard from its unique uid
byte[]	getIcon(java.lang.String uid) A scaled-down (22px x 22px) version of the photo
ItemValue<VCardInfo>	getInfo(java.lang.String uid) Fetch a VCardInfo from its unique uid
byte[]	getPhoto(java.lang.String uid)
void	move(java.util.List<java.lang.String> uids, java.lang.String descContainerUid) Move entries from one AddressBook to another one
java.util.List<ItemValue<VCard>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple VCards from theirs uniques uids
void	reset()
ListResult<ItemValue<VCardInfo>>	search(VCardQuery query) ElasticSearch based vcard search
void	setPhoto(java.lang.String uid, byte[] photo)
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VCardChanges changes) CLIENT_WIN style
void	update(java.lang.String uid, VCard card) Modifies an existing VCard entry.
ContainerUpdatesResult	updates(VCardChanges changes) Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)

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

changeset, changesetById, containerChangelog, getVersion, itemChangelog

Method Detail

allUids

@GET
java.util.List<java.lang.String> allUids()
                                       throws ServerFault

List all items from container

Returns:

Throws:

ServerFault

create

@PUT
 @Path(value="{uid}")
void create(@PathParam(value="uid")
                                       java.lang.String uid,
                                       VCard card)
                                throws ServerFault

Creates a new VCard entry.

Parameters:

uid - uid of the entry

card - value of the entry

Throws:

ServerFault

createById

@PUT
 @Path(value="_byId")
void createById(@QueryParam(value="id")
                                           long id,
                                           VCard card)
                                    throws ServerFault

Throws:

ServerFault

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.String uid,
                                        VCard card)
                                 throws ServerFault

Modifies an existing VCard entry.

Parameters:

uid - uid of the entry

card - value of the entry

Throws:

ServerFault

getComplete

@GET
 @Path(value="{uid}/complete")
ItemValue<VCard> getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)
                                                          throws ServerFault

Fetch a VCard from its unique uid

Parameters:

uid -

Returns:

ItemValue

Throws:

ServerFault

multipleGet

@POST
 @Path(value="_mget")
java.util.List<ItemValue<VCard>> multipleGet(java.util.List<java.lang.String> uids)
                                                                  throws ServerFault

Fetch multiple VCards from theirs uniques uids

Parameters:

uids -

Returns:

List>

Throws:

ServerFault

getInfo

@GET
 @Path(value="{uid}/info")
ItemValue<VCardInfo> getInfo(@PathParam(value="uid")
                                                             java.lang.String uid)
                                                      throws ServerFault

Fetch a VCardInfo from its unique uid

Parameters:

uid -

Returns:

Throws:

ServerFault

delete

@DELETE
 @Path(value="{uid}")
void delete(@PathParam(value="uid")
                                          java.lang.String uid)
                                   throws ServerFault

Delete vcard entry

Parameters:

uid -

Throws:

ServerFault

search

@POST
 @Path(value="_search")
ListResult<ItemValue<VCardInfo>> search(VCardQuery query)
                                                               throws ServerFault

ElasticSearch based vcard search

Parameters:

query -

Returns:

Throws:

ServerFault

updates

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

Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)

Parameters:

changes -

Throws:

ServerFault

sync

@POST
 @Path(value="_sync")
ContainerChangeset<java.lang.String> sync(@QueryParam(value="since")
                                                                      java.lang.Long since,
                                                                      VCardChanges changes)
                                                               throws ServerFault

CLIENT_WIN style

Parameters:

since -

changes -

Returns:

Throws:

ServerFault

setPhoto

@POST
 @Path(value="{uid}/photo")
void setPhoto(@PathParam(value="uid")
                                                java.lang.String uid,
                                                byte[] photo)
                                         throws ServerFault

Throws:

ServerFault

getPhoto

@GET
 @Path(value="{uid}/photo")
 @Produces(value="image/png")
byte[] getPhoto(@PathParam(value="uid")
                                                                               java.lang.String uid)
                                                                        throws ServerFault

Throws:

ServerFault

deletePhoto

@DELETE
 @Path(value="{uid}/photo")
void deletePhoto(@PathParam(value="uid")
                                                     java.lang.String uid)
                                              throws ServerFault

Throws:

ServerFault

getIcon

@GET
 @Path(value="{uid}/icon")
 @Produces(value="image/png")
byte[] getIcon(@PathParam(value="uid")
                                                                             java.lang.String uid)
                                                                      throws ServerFault

A scaled-down (22px x 22px) version of the photo

Parameters:

uid -

Returns:

Throws:

ServerFault

copy

@POST
 @Path(value="_copy/{destContainerUid}")
void copy(java.util.List<java.lang.String> uids,
                                                         @PathParam(value="destContainerUid")
                                                         java.lang.String descContainerUid)
                                                  throws ServerFault

Copy entries from one AddressBook to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

move

@POST
 @Path(value="_move/{destContainerUid}")
void move(java.util.List<java.lang.String> uids,
                                                         @PathParam(value="destContainerUid")
                                                         java.lang.String descContainerUid)
                                                  throws ServerFault

Move entries from one AddressBook to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

reset

@POST
 @Path(value="_reset")
void reset()
                                 throws ServerFault

Throws:

ServerFault