net.bluemind.folder.api

Interface IFolderHierarchy

All Known Subinterfaces:

IInternalFolderHierarchy, IInternalMailboxFolderHierarchy, IInternalMailboxFolderHierarchy, IMailboxFolderHierarchy

All Known Implementing Classes:

FolderHierarchyService, MailboxFolderHierarchyService

@Path(value="/folders/{mailboxUid}")
public interface IFolderHierarchy

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	allUids()
ItemValue<Folder>	byContentUri(java.lang.String uri)
ItemValue<Folder>	byId(java.lang.Long id)
java.util.List<ItemValue<Folder>>	byParentId(java.lang.Long pid)
ItemValue<Folder>	byUid(java.lang.Long uid)
ContainerChangelog	changelog(java.lang.Long since) ChangeLog of the container since
ContainerChangeset<java.lang.String>	changeset(java.lang.Long since) ChangeSet of the container since
ContainerChangeset<java.lang.Long>	changesetById(java.lang.Long since) ChangeSet of the container since
ItemValue<Folder>	getComplete(java.lang.String uid) Fetch a Folder from its unique uid
java.util.List<ItemValue<Folder>>	multipleGet(java.util.List<java.lang.String> uids) Fetch multiple Folders from theirs uniques uids
void	reset()
ListResult<ItemValue<Folder>>	search(FolderQuery query) Searches for the Folders items in the container using the given query

Method Detail

getComplete

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

Fetch a Folder from its unique uid

Parameters:

uid -

Returns:

ItemValue

Throws:

ServerFault

multipleGet

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

Fetch multiple Folders from theirs uniques uids

Parameters:

uids -

Returns:

List>

Throws:

ServerFault

changelog

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

ChangeLog of the container since

Parameters:

since - timestamp of first changes we want to retrieve

Returns:

ContainerChangelog

Throws:

ServerFault

changeset

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

ChangeSet of the container since

Parameters:

since - timestamp of first changes we want to retrieve

Throws:

ServerFault

changesetById

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

ChangeSet of the container since

Parameters:

since - timestamp of first changes we want to retrieve

Throws:

ServerFault

byContentUri

@GET
 @Path(value="by_uri")
ItemValue<Folder> byContentUri(@QueryParam(value="uri")
                                                           java.lang.String uri)
                                                    throws ServerFault

Throws:

ServerFault

byParentId

@GET
 @Path(value="by_parent_id")
java.util.List<ItemValue<Folder>> byParentId(@QueryParam(value="parent")
                                                                               java.lang.Long pid)
                                                                        throws ServerFault

Throws:

ServerFault

byUid

@GET
 @Path(value="by_uid")
ItemValue<Folder> byUid(@QueryParam(value="uid")
                                                    java.lang.Long uid)
                                             throws ServerFault

Throws:

ServerFault

byId

@GET
 @Path(value="by_id")
ItemValue<Folder> byId(@QueryParam(value="id")
                                                  java.lang.Long id)
                                           throws ServerFault

Throws:

ServerFault

search

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

Searches for the Folders items in the container using the given query

Parameters:

query - the search criteria

Returns:

matching Folder objects

Throws:

ServerFault

allUids

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

Throws:

ServerFault

reset

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

Throws:

ServerFault