org.exoplatform.social.service.rest
Class SpacesRestService

java.lang.Object
  org.exoplatform.social.service.rest.SpacesRestService

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class SpacesRestService
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Provides services for space gadget to display user's spaces and pending spaces.

Nested Class Summary

static class	SpacesRestService.SpaceList List that contains space from space service. Need this class for converter from rest service.
static class	SpacesRestService.SpaceNameList

Constructor Summary

SpacesRestService()
constructor

Method Summary

javax.ws.rs.core.Response	getLastVisitedSpace(javax.ws.rs.core.UriInfo uriInfo, String portalName, String format, String appId, int offset, int limit) Provides a way to get last n space ordered by last access and be able to filter on containing application of the authenticated user identity who makes this request.
javax.ws.rs.core.Response	showMySpaceList(javax.ws.rs.core.UriInfo uriInfo, String portalName, String format) Shows mySpaceList by json/xml format
javax.ws.rs.core.Response	showPendingSpaceList(javax.ws.rs.core.UriInfo uriInfo, String portalName, String format) Shows pendingSpaceList by json/xml format
javax.ws.rs.core.Response	suggestSpacenames(javax.ws.rs.core.UriInfo uriInfo, String portalName, String conditionToSearch, String typeOfRelation, String userId, String format) Suggests space's name for searching.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SpacesRestService

public SpacesRestService()

constructor

Method Detail

showMySpaceList

public javax.ws.rs.core.Response showMySpaceList(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String portalName,
                                                 String format)
                                          throws Exception

Shows mySpaceList by json/xml format

Parameters:

uriInfo - The request URI information.

portalName - The name of current container.

format - The type of returned result.

Returns:

response

Throws:

Exception

getLastVisitedSpace

public javax.ws.rs.core.Response getLastVisitedSpace(@Context
                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                     String portalName,
                                                     String format,
                                                     String appId,
                                                     int offset,
                                                     int limit)
                                              throws Exception

Provides a way to get last n space ordered by last access and be able to filter on containing application of the authenticated user identity who makes this request.

Parameters:

uriInfo - The request URI information.

portalContainerName - The portal container name.

format - The response format type, for example: JSON, or XML.

offset - Specify the from number of spaces to retrieve. It must be greater than or equal to 0.

limit - Specify the number of spaces to retrieve. It must be less than or equal to 10.

appId - AppId which contains in Space to filter. Such as Wiki, Discussion, Documents, Agenda ...etc

Returns:

the response

Throws:

Exception

showPendingSpaceList

public javax.ws.rs.core.Response showPendingSpaceList(@Context
                                                      javax.ws.rs.core.UriInfo uriInfo,
                                                      String portalName,
                                                      String format)
                                               throws Exception

Shows pendingSpaceList by json/xml format

Parameters:

uriInfo - The request URI information.

portalContainerName - The portal container name.

format - The response format type, for example: JSON, or XML.

Returns:

response

Throws:

Exception

suggestSpacenames

public javax.ws.rs.core.Response suggestSpacenames(@Context
                                                   javax.ws.rs.core.UriInfo uriInfo,
                                                   String portalName,
                                                   String conditionToSearch,
                                                   String typeOfRelation,
                                                   String userId,
                                                   String format)
                                            throws Exception

Suggests space's name for searching.

Parameters:

uriInfo - The request URI information.

portalName - The name of portal.

conditionToSearch - The input information to search.

typeOfRelation - The type of relationship of user and space.

userId - Id of current user.

format - The response format type, for example: JSON, or XML.

Returns:

Throws:

Exception