org.silverpeas.admin.web
Class AdminWebService

java.lang.Object
  org.silverpeas.admin.web.AdminWebService

@Named
public class AdminWebService
extends Object

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

Author:

Yohann Chastagnier

Constructor Summary

AdminWebService()

Method Summary

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
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 -

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 -

userId -

Returns:

never null String array

getSpaceById

public SpaceInstLight getSpaceById(String spaceId)

Gets a space from its id

Parameters:

spaceId -

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 -

userId -

Returns:

never null String array

getComponentById

public ComponentInstLight getComponentById(String componentId)

Gets a component from its id

Parameters:

componentId -

Returns:

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