Package org.silverpeas.core.webapi.admin

Class AdminWebService

java.lang.Object

org.silverpeas.core.webapi.admin.AdminWebService

@Service
public class AdminWebService
extends Object

This service provides several common operations for the REST-based resources representing admin entities.

Author:

Yohann Chastagnier

Constructor Summary

Constructors

Constructor	Description
AdminWebService()

Method Summary

Modifier and Type	Method	Description
String[]	getAllComponentIds(String spaceId, String userId)	Gets ids of available components of a space and a user.
String[]	getAllRootSpaceIds(String userId)	Gets ids of available root spaces of a user
String[]	getAllSubSpaceIds(String spaceId, String userId)	Gets ids of available spaces of a space and a user.
ComponentInstLight	getComponentById(String componentId)	Gets a component from its id
List<ComponentInstLight>	getComponentsByParameterValue(String param, String value)
SpaceInstLight	getSpaceById(String spaceId)	Gets a space from its id

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminWebService

public AdminWebService()

Method Detail

getAllRootSpaceIds

public String[] getAllRootSpaceIds(String userId)

Gets ids of available root spaces of a user

Parameters:

userId - a user identifier

Returns:

never null String array

getAllSubSpaceIds

public String[] getAllSubSpaceIds(String spaceId,
                                  String userId)

Gets ids of available spaces of a space and a user. It returns only spaces of the next level

Parameters:

spaceId - a space identifier

userId - a user identifier

Returns:

never null String array

getSpaceById

public SpaceInstLight getSpaceById(String spaceId)

Gets a space from its id

Parameters:

spaceId - a space identifier

Returns:

SpaceInstLight instantiated or null if not exists one with the given space id

getAllComponentIds

public String[] getAllComponentIds(String spaceId,
                                   String userId)

Gets ids of available components of a space and a user.

Parameters:

spaceId - a space identifier

userId - a user identifier

Returns:

never null String array

getComponentById

public ComponentInstLight getComponentById(String componentId)

Gets a component from its id

Parameters:

componentId - a component identifier

Returns:

ComponentInstLight instantiated or null if not exists one with the given component id

getComponentsByParameterValue

public List<ComponentInstLight> getComponentsByParameterValue(String param,
                                                              String value)