org.exoplatform.social.rest.api

Interface GroupSpaceBindingRestResources

All Superinterfaces:

org.exoplatform.services.rest.resource.ResourceContainer, SocialRest

All Known Implementing Classes:

GroupSpaceBindingRestResourcesV1

public interface GroupSpaceBindingRestResources
extends SocialRest

Provides REST/JSON API to manage the binding between a space and an organization group.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteSpaceBinding(javax.ws.rs.core.UriInfo uriInfo, String bindingId) Delete a binding by id.
javax.ws.rs.core.Response	getBindingReportOperations(javax.ws.rs.core.UriInfo uriInfo)
javax.ws.rs.core.Response	getBindingsBySpaceId(javax.ws.rs.core.UriInfo uriInfo, String spaceId, int offset, int limit, boolean returnSize) Return a list of binding in json format
javax.ws.rs.core.Response	getGroupsTree(javax.ws.rs.core.UriInfo uriInfo) Return the groups in a tree structure of json format
javax.ws.rs.core.Response	getReport(javax.ws.rs.core.UriInfo uriInfo, String spaceId, String action, String group, String groupBindingId)
javax.ws.rs.core.Response	saveGroupSpaceBindings(javax.ws.rs.core.UriInfo uriInfo, String spaceId, List<String> groupNamesList) Return a list of binding in json format

Method Detail

getBindingsBySpaceId

javax.ws.rs.core.Response getBindingsBySpaceId(@Context
                                               javax.ws.rs.core.UriInfo uriInfo,
                                               String spaceId,
                                               int offset,
                                               int limit,
                                               boolean returnSize)
                                        throws Exception

Return a list of binding in json format

Parameters:

uriInfo -

spaceId - Id of the space

offset - Bindings list offset

limit - Bindings list limit

returnSize - Return Size of the list?

Returns:

List of binding object for this context (space + role)

Throws:

Exception

saveGroupSpaceBindings

javax.ws.rs.core.Response saveGroupSpaceBindings(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String spaceId,
                                                 List<String> groupNamesList)
                                          throws Exception

Return a list of binding in json format

Parameters:

uriInfo -

spaceId - Id of the space

groupNamesList - List of group names to be bound to the space

Returns:

Status

Throws:

Exception

deleteSpaceBinding

javax.ws.rs.core.Response deleteSpaceBinding(@Context
                                             javax.ws.rs.core.UriInfo uriInfo,
                                             String bindingId)
                                      throws Exception

Delete a binding by id.

Parameters:

uriInfo -

bindingId - Id of the space

Returns:

Status

Throws:

Exception

getGroupsTree

javax.ws.rs.core.Response getGroupsTree(@Context
                                        javax.ws.rs.core.UriInfo uriInfo)
                                 throws Exception

Return the groups in a tree structure of json format

Parameters:

uriInfo -

Returns:

Throws:

Exception

getReport

javax.ws.rs.core.Response getReport(@Context
                                    javax.ws.rs.core.UriInfo uriInfo,
                                    String spaceId,
                                    String action,
                                    String group,
                                    String groupBindingId)
                             throws Exception

Parameters:

uriInfo -

spaceId -

action -

group -

groupBindingId -

Returns:

Throws:

Exception

getBindingReportOperations

javax.ws.rs.core.Response getBindingReportOperations(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo)
                                              throws Exception

Throws:

Exception