Package org.silverpeas.core.webapi.admin.delegate

Class AdminPersonalWebDelegate

java.lang.Object

org.silverpeas.core.webapi.admin.delegate.AdminPersonalWebDelegate

public class AdminPersonalWebDelegate
extends Object

Author:

Yohann Chastagnier

Method Summary

Modifier and Type	Method	Description
WAComponent	discardComponent(String componentName)	Deletes from the user's personal space the instantiation of the requested component
String	getComponentLabel(SilverpeasComponent component)	Gets the WAComponent label
static AdminPersonalWebDelegate	getInstance(User user, UserPreferences userPreference, LookWebDelegate lookDelegate)	Easy way to instance the look service provider.
Collection<WAComponent>	getNotUsedComponents()
Collection<ComponentInst>	getUsedComponents()
Collection<AbstractTool>	getUsedTools()
ComponentInst	useComponent(String componentName)	Instantiates the requested component in the user's personal space

Methods inherited from class java.lang.Object

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

Method Detail

getComponentLabel

public String getComponentLabel(SilverpeasComponent component)

Gets the WAComponent label

Parameters:

component -

Returns:

the component label

getNotUsedComponents

public Collection<WAComponent> getNotUsedComponents()

Returns:

all components that can be handled in personnal space but not used yet.

getUsedComponents

public Collection<ComponentInst> getUsedComponents()

Returns:

used components instanciated in the user personal space.

getUsedTools

public Collection<AbstractTool> getUsedTools()

Returns:

used tools in the user personal space.

useComponent

public ComponentInst useComponent(String componentName)
                           throws Exception

Instantiates the requested component in the user's personal space

Parameters:

componentName - the WAComponent name

Returns:

the instantiated component

Throws:

Exception

discardComponent

public WAComponent discardComponent(String componentName)
                             throws Exception

Deletes from the user's personal space the instantiation of the requested component

Parameters:

componentName - the WAComponent name

Returns:

the WAComponent

Throws:

Exception

getInstance

public static AdminPersonalWebDelegate getInstance(User user,
                                                   UserPreferences userPreference,
                                                   LookWebDelegate lookDelegate)

Easy way to instance the look service provider.

Parameters:

user - the user detail

userPreference - the user preference

lookDelegate - a delegate of the Web look é@return a delegate