net.bluemind.addressbook.api

Interface IAddressBook

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<VCard>, IDataShardSupport, ISortingSupport

All Known Subinterfaces:

IInCoreAddressBook

All Known Implementing Classes:

AddressBookService

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

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.
Ack	createById(long id, VCard value)
void	createWithItem(ItemValue<VCard> cardItem)
void	delete(java.lang.String uid) Delete vcard entry
void	deleteById(long id)
void	deletePhoto(java.lang.String uid)
ItemValue<VCard>	getComplete(java.lang.String uid) Fetch a VCard from its unique uid
ItemValue<VCard>	getCompleteById(long id)
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
java.util.List<ItemValue<VCard>>	multipleGetById(java.util.List<java.lang.Long> ids) Fetch multiple VCards from theirs uniques ids
void	reset()
ListResult<ItemValue<VCardInfo>>	search(VCardQuery query) ElasticSearch based vcard search
void	setPhoto(java.lang.String uid, byte[] photo)
java.util.List<java.lang.Long>	sortedIds(SortDescriptor sorted) Returns all items in a container matching a sort criteria
ContainerChangeset<java.lang.String>	sync(java.lang.Long since, VCardChanges changes) CLIENT_WIN style
void	touch(java.lang.String uid) Touch a VCard.
void	update(java.lang.String uid, VCard card) Modifies an existing VCard entry.
Ack	updateById(long id, VCard value)
ContainerUpdatesResult	updates(VCardChanges changes) Updates multiples entries at once (should be transactional: if one operation fail, nothing is written)
void	updateWithItem(ItemValue<VCard> cardItem)

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

allIds, changeset, changesetById, containerChangelog, filteredChangesetById, getVersion, itemChangelog

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

multipleDeleteById

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

count

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

xfer

Method Detail

allUids

@GET
 @Path(value="_all")
java.util.List<java.lang.String> allUids()

List all items from container

Returns:

Throws:

ServerFault

create

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

Creates a new VCard entry.

Parameters:

uid - uid of the entry

card - value of the entry

Throws:

ServerFault

createById

@PUT
 @Path(value="id/{id}")
Ack createById(@PathParam(value="id")
                                            long id,
                                            VCard value)

Specified by:

createById in interface ICrudByIdSupport<VCard>

createWithItem

@PUT
 @Path(value="_createWithItem")
void createWithItem(ItemValue<VCard> cardItem)

getCompleteById

@GET
 @Path(value="id/{id}")
ItemValue<VCard> getCompleteById(@PathParam(value="id")
                                                              long id)

Specified by:

getCompleteById in interface ICrudByIdSupport<VCard>

updateById

@POST
 @Path(value="id/{id}")
Ack updateById(@PathParam(value="id")
                                             long id,
                                             VCard value)

Specified by:

updateById in interface ICrudByIdSupport<VCard>

updateWithItem

@POST
 @Path(value="_updateWithItem")
void updateWithItem(ItemValue<VCard> cardItem)

deleteById

@DELETE
 @Path(value="id/{id}")
void deleteById(@PathParam(value="id")
                                                long id)

Specified by:

deleteById in interface ICrudByIdSupport<VCard>

update

@POST
 @Path(value="{uid}")
void update(@PathParam(value="uid")
                                        java.lang.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(value="{uid}/complete")
ItemValue<VCard> getComplete(@PathParam(value="uid")
                                                                 java.lang.String uid)

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)

Fetch multiple VCards from theirs uniques uids

Parameters:

uids -

Returns:

List>

Throws:

ServerFault

multipleGetById

@POST
 @Path(value="_mgetById")
java.util.List<ItemValue<VCard>> multipleGetById(java.util.List<java.lang.Long> ids)

Fetch multiple VCards from theirs uniques ids

Parameters:

ids -

Returns:

List>

Throws:

ServerFault

getInfo

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

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)

Delete vcard entry

Parameters:

uid -

Throws:

ServerFault

search

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

ElasticSearch based vcard search

Parameters:

query -

Returns:

Throws:

ServerFault

updates

@PUT
 @Path(value="_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(value="_sync")
ContainerChangeset<java.lang.String> sync(@QueryParam(value="since")
                                                                      java.lang.Long since,
                                                                      VCardChanges changes)

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)

getPhoto

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

deletePhoto

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

getIcon

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

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)

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)

Move entries from one AddressBook to another one

Parameters:

uids -

descContainerUid -

Throws:

ServerFault

reset

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

Throws:

ServerFault

sortedIds

@POST
 @Path(value="_sorted")
java.util.List<java.lang.Long> sortedIds(SortDescriptor sorted)

Description copied from interface: ISortingSupport

Returns all items in a container matching a sort criteria

Specified by:

sortedIds in interface ISortingSupport

Parameters:

sorted - sorting criteria

Returns:

a list of ItemValue.internalId sorted

touch

@POST
 @Path(value="{uid}/_touch")
void touch(java.lang.String uid)

Touch a VCard.

Parameters:

uid - the unique identifier of the vcard