Package net.bluemind.addressbook.api

Interface IAddressBook

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VCard>, IDataShardSupport, IReadByIdSupport<VCard>, IRestoreCrudSupport<VCard>, IRestoreItemCrudSupport<VCard>, IRestoreSupport<VCard>, ISortingSupport

@Path("/addressbooks/{containerUid}")
public interface IAddressBook
extends IChangelogSupport, ICrudByIdSupport<VCard>, ICountingSupport, ISortingSupport, IDataShardSupport, IRestoreItemCrudSupport<VCard>

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

Method Summary

Modifier and Type	Method	Description
List<String>	allUids()	List all items from container
void	copy(List<String> uids, String descContainerUid)	Copy entries from one AddressBook to another one
void	create(String uid, VCard card)	Creates a new VCard entry.
void	delete(String uid)	Delete vcard entry
void	deletePhoto(String uid)
ItemValue<VCard>	getComplete(String uid)	Fetch a VCard from its unique uid
byte[]	getIcon(String uid)	A scaled-down (22px x 22px) version of the photo
ItemValue<VCardInfo>	getInfo(String uid)	Fetch a VCardInfo from its unique uid
byte[]	getPhoto(String uid)
void	move(List<String> uids, String descContainerUid)	Move entries from one AddressBook to another one
List<ItemValue<VCard>>	multipleGet(List<String> uids)	Fetch multiple VCards from theirs uniques uids
void	reset()
ListResult<ItemValue<VCardInfo>>	search(VCardQuery query)	ElasticSearch based vcard search
void	setPhoto(String uid, byte[] photo)
ContainerChangeset<String>	sync(Long since, VCardChanges changes)	CLIENT_WIN style
void	touch(String uid)	Touch a VCard.
void	update(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

allIds, changeset, changesetById, filteredChangesetById, getVersion, itemChangelog

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

count

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

createById, deleteById, multipleDeleteById, updateById

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

xfer

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

getCompleteById, multipleGetById

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

get, restore

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

sortedIds

Method Details

allUids

@GET
@Path("_all")
List<String> allUids()

List all items from container

Returns:

Throws:

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:

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:

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 IRestoreItemCrudSupport<VCard>

Parameters:

uid -

Returns:

ItemValue<VCard>

Throws:

ServerFault

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:

ServerFault

getInfo

@GET
@Path("{uid}/info")
ItemValue<VCardInfo> getInfo(@PathParam("uid")
 String uid)

Fetch a VCardInfo from its unique uid

Parameters:

uid -

Returns:

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)

Delete vcard entry

Specified by:

delete in interface IRestoreCrudSupport<VCard>

Parameters:

uid -

Throws:

ServerFault

search

@POST
@Path("_search")
ListResult<ItemValue<VCardInfo>> search(VCardQuery query)

ElasticSearch based vcard search

Parameters:

query -

Returns:

Throws:

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:

ServerFault

sync

@POST
@Path("_sync")
ContainerChangeset<String> sync(@QueryParam("since")
 Long since,
 VCardChanges changes)

CLIENT_WIN style

Parameters:

since -

changes -

Returns:

Throws:

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:

ServerFault

copy

@POST
@Path("_copy/{destContainerUid}")
void copy(List<String> uids,
 @PathParam("destContainerUid")
 String descContainerUid)

Copy entries from one AddressBook to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

move

@POST
@Path("_move/{destContainerUid}")
void move(List<String> uids,
 @PathParam("destContainerUid")
 String descContainerUid)

Move entries from one AddressBook to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

reset

@POST
@Path("_reset")
void reset()

Throws:

ServerFault

touch

@POST
@Path("{uid}/_touch")
void touch(String uid)

Touch a VCard.

Parameters:

uid - the unique identifier of the vcard