net.bluemind.exchange.mapi.api

Interface IMapiFolder

All Superinterfaces:

IChangelogSupport, ICountingSupport, ICrudByIdSupport<MapiRawMessage>, IDataShardSupport, IReadByIdSupport<MapiRawMessage>, ISortingSupport

All Known Implementing Classes:

MapiFolderService

@Path(value="/mapi_folder/{containerUid}")
public interface IMapiFolder
extends ICrudByIdSupport<MapiRawMessage>, IChangelogSupport, ICountingSupport, ISortingSupport, IDataShardSupport

Method Summary

Modifier and Type	Method and Description
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since)
ContainerChangeset<java.lang.Long>	changesetById(java.lang.Long since)
ContainerChangelog	containerChangelog(java.lang.Long since)
Count	count(ItemFlagFilter filter) Count items matching an ItemFlagFilter
Ack	createById(long id, MapiRawMessage value)
void	deleteById(long id)
ContainerChangeset<ItemVersion>	filteredChangesetById(java.lang.Long since, ItemFlagFilter filter)
ItemValue<MapiRawMessage>	getCompleteById(long id)
long	getVersion()
ItemChangelog	itemChangelog(java.lang.String itemUid, java.lang.Long since)
void	reset()
Ack	updateById(long id, MapiRawMessage value)

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

multipleDeleteById

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

multipleGetById

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

allIds

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

sortedIds

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

xfer

Method Detail

reset

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

getCompleteById

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

Specified by:

getCompleteById in interface IReadByIdSupport<MapiRawMessage>

updateById

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

Specified by:

updateById in interface ICrudByIdSupport<MapiRawMessage>

createById

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

Specified by:

createById in interface ICrudByIdSupport<MapiRawMessage>

deleteById

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

Specified by:

deleteById in interface ICrudByIdSupport<MapiRawMessage>

itemChangelog

@GET
 @Path(value="{uid}/_itemchangelog")
ItemChangelog itemChangelog(@PathParam(value="uid")
                                                                      java.lang.String itemUid,
                                                                      java.lang.Long since)
                                                               throws ServerFault

Specified by:

itemChangelog in interface IChangelogSupport

Returns:

if successful, return a ContainerChangelog

Throws:

ServerFault

containerChangelog

@GET
 @Path(value="_changelog")
ContainerChangelog containerChangelog(java.lang.Long since)
                                                               throws ServerFault

Specified by:

containerChangelog in interface IChangelogSupport

Returns:

if successful, return a ContainerChangelog

Throws:

ServerFault

changeset

@GET
 @Path(value="_changeset")
ContainerChangeset<java.lang.String> changeset(@QueryParam(value="since")
                                                                               java.lang.Long since)
                                                                        throws ServerFault

Specified by:

changeset in interface IChangelogSupport

Returns:

if successful, return a ContainerChangeset

Throws:

ServerFault

changesetById

@GET
 @Path(value="_changesetById")
ContainerChangeset<java.lang.Long> changesetById(@QueryParam(value="since")
                                                                                     java.lang.Long since)
                                                                              throws ServerFault

Specified by:

changesetById in interface IChangelogSupport

Returns:

if successful, return a ContainerChangeset with internal numeric ids

Throws:

ServerFault

filteredChangesetById

@POST
 @Path(value="_filteredChangesetById")
ContainerChangeset<ItemVersion> filteredChangesetById(@QueryParam(value="since")
                                                                                                   java.lang.Long since,
                                                                                                   ItemFlagFilter filter)
                                                                                            throws ServerFault

Specified by:

filteredChangesetById in interface IChangelogSupport

filter - to exclude some items (eg. deleted items)

Returns:

if successful, return a ContainerChangeset with internal numeric ids matching the given filter

Throws:

ServerFault

count

@POST
 @Path(value="_count")
Count count(ItemFlagFilter filter)
                                  throws ServerFault

Description copied from interface: ICountingSupport

Count items matching an ItemFlagFilter

Specified by:

count in interface ICountingSupport

Returns:

the count of items matching the filter

Throws:

ServerFault

getVersion

@GET
 @Path(value="_version")
long getVersion()
                                       throws ServerFault

Specified by:

getVersion in interface IChangelogSupport

Throws:

ServerFault