net.bluemind.core.container.api

Interface IContainers

All Known Implementing Classes:

Containers

@Path(value="/containers/_manage")
public interface IContainers

Method Summary

Modifier and Type	Method and Description
java.util.List<ContainerDescriptor>	all(ContainerQuery query)
java.util.List<ContainerDescriptor>	allForUser(java.lang.String domainUid, java.lang.String userUid, ContainerQuery query)
java.util.List<BaseContainerDescriptor>	allLight(ContainerQuery query)
void	create(java.lang.String uid, ContainerDescriptor descriptor) Create a container
void	delete(java.lang.String uid) Delete a container
ContainerDescriptor	get(java.lang.String uid) Get a container
java.util.List<ContainerDescriptor>	getContainers(java.util.List<java.lang.String> containerIds) Get container
ContainerDescriptor	getForUser(java.lang.String domainUid, java.lang.String userUid, java.lang.String uid) Get a container as if it where requested by another user.
ContainerDescriptor	getIfPresent(java.lang.String uid) Get a container
void	setAccessControlList(java.lang.String uid, java.util.List<AccessControlEntry> entries)
void	update(java.lang.String uid, ContainerModifiableDescriptor descriptor) Update a container

Method Detail

get

@GET
 @Path(value="{uid}")
ContainerDescriptor get(@PathParam(value="uid")
                                                   java.lang.String uid)
                                            throws ServerFault

Get a container

Parameters:

uid -

Returns:

Throws:

ServerFault

getForUser

@GET
 @Path(value="_forUser")
ContainerDescriptor getForUser(@QueryParam(value="domainUid")
                                                             java.lang.String domainUid,
                                                             @QueryParam(value="userUid")
                                                             java.lang.String userUid,
                                                             @QueryParam(value="uid")
                                                             java.lang.String uid)
                                                      throws ServerFault

Get a container as if it where requested by another user.

Parameters:

domainUid -

userUid -

uid -

Returns:

Throws:

ServerFault

getIfPresent

@GET
 @Path(value="_ifPresent/{uid}")
ContainerDescriptor getIfPresent(@PathParam(value="uid")
                                                                       java.lang.String uid)
                                                                throws ServerFault

Get a container

Parameters:

uid -

Returns:

Throws:

ServerFault

create

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

Create a container

Parameters:

uid -

descriptor -

Throws:

ServerFault

delete

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

Delete a container

Parameters:

uid -

Throws:

ServerFault

update

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

Update a container

Parameters:

uid -

descriptor -

Throws:

ServerFault

all

@POST
 @Path(value="_list")
java.util.List<ContainerDescriptor> all(ContainerQuery query)
                                                             throws ServerFault

Parameters:

containerQuery -

Returns:

List of all "readeable" containers for current User

Throws:

ServerFault

allLight

@POST
 @Path(value="_listLight")
java.util.List<BaseContainerDescriptor> allLight(ContainerQuery query)
                                                                           throws ServerFault

Throws:

ServerFault

allForUser

@POST
 @Path(value="_listforuser")
java.util.List<ContainerDescriptor> allForUser(@QueryParam(value="domainUid")
                                                                                  java.lang.String domainUid,
                                                                                  @QueryParam(value="userUid")
                                                                                  java.lang.String userUid,
                                                                                  ContainerQuery query)
                                                                           throws ServerFault

Parameters:

containerQuery -

Returns:

List of all "readeable" containers for current User

Throws:

ServerFault

getContainers

@POST
 @Path(value="_mget")
java.util.List<ContainerDescriptor> getContainers(java.util.List<java.lang.String> containerIds)
                                                                       throws ServerFault

Get container

Parameters:

containerIds -

Returns:

ContainerDescriptor list

Throws:

ServerFault

setAccessControlList

@POST
 @Path(value="{uid}/_acl")
void setAccessControlList(@PathParam(value="uid")
                                                           java.lang.String uid,
                                                           java.util.List<AccessControlEntry> entries)
                                                    throws ServerFault

Throws:

ServerFault