Package org.silverpeas.core.admin.component.model

Class Tool

java.lang.Object

org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent

org.silverpeas.core.admin.component.model.Tool

All Implemented Interfaces:

SilverpeasComponent

public class Tool
extends AbstractSilverpeasComponent

A tool represents a Personal Application Component. It is an application dedicated to be instantiated for each user in their personal space.

The tools available in Silverpeas are loaded by the org.silverpeas.core.admin.component .ToolRegistry registry, among of them from their XML descriptor. They can be the accessed either by the registry itself or by the Tool class (it delegates the access to the registry). The XML descriptor of a personal application component is defined by the following XSD: https://www.silverpeas.org/xsd/component.xsd.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	id

Fields inherited from class org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent

indexedParametersByName

Constructor Summary

Constructors

Constructor	Description
Tool(String id)

Method Summary

Modifier and Type	Method	Description
static Collection<Tool>	getAll()	Gets all the available Tool instances.
static Optional<Tool>	getById(String toolId)	Gets the Tool instance with the specified id.
protected Map<String,String>	getDescription()	Gets the value of the description property.
List<GroupOfParameters>	getGroupsOfParameters()	Gets groups of parameters.
protected Map<String,String>	getLabel()	Gets the value of the label property.
String	getName()	Gets the type of the component.
List<Parameter>	getParameters()	Gets the instance parameters of the Silverpeas component.
boolean	hasParameterDefined(String parameterName)	Indicates if a parameter is defined which name is equal to the given method parameter.
boolean	isPersonal()	Indicates if the component instance is a personal one. A personal component instance is linked to a user.
boolean	isVisible()	Gets the value of the visible property.

Methods inherited from class org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent

getDescription, getIndexedParametersByName, getLabel, getSortedGroupsOfParameters, getSortedParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.silverpeas.core.admin.component.model.SilverpeasComponent

getAllParameters, isInheritSpaceRightsByDefault, isPublicByDefault, isTopicTracker, isWorkflow

Field Detail

id

protected final String id

Constructor Detail

Tool

public Tool(String id)

Method Detail

getById

public static Optional<Tool> getById(String toolId)

Gets the Tool instance with the specified id.

Parameters:

toolId - the unique id (or unique id) of the Tool to return.

Returns:

optionally a Tool instance with the given id.

getAll

public static Collection<Tool> getAll()

Gets all the available Tool instances.

Returns:

a collection of Tool instance.

getName

public String getName()

Description copied from interface: SilverpeasComponent

Gets the type of the component.

Returns:

the application name.

getLabel

protected Map<String,String> getLabel()

Description copied from class: AbstractSilverpeasComponent

Gets the value of the label property.

Specified by:

getLabel in class AbstractSilverpeasComponent

Returns:

possible object is Multilang

isVisible

public boolean isVisible()

Description copied from interface: SilverpeasComponent

Gets the value of the visible property.

isPersonal

public boolean isPersonal()

Description copied from interface: SilverpeasComponent

Indicates if the component instance is a personal one.
A personal component instance is linked to a user.

Returns:

true if it is a personal one, false otherwise.

getDescription

protected Map<String,String> getDescription()

Description copied from class: AbstractSilverpeasComponent

Gets the value of the description property.

Specified by:

getDescription in class AbstractSilverpeasComponent

Returns:

possible object is Multilang

getParameters

public List<Parameter> getParameters()

Description copied from interface: SilverpeasComponent

Gets the instance parameters of the Silverpeas component.

Returns:

list of Parameter

hasParameterDefined

public boolean hasParameterDefined(String parameterName)

Description copied from interface: SilverpeasComponent

Indicates if a parameter is defined which name is equal to the given method parameter.

Parameters:

parameterName - the parameter name to perform.

Returns:

true if a parameter is defined behind the specified method parameter, false otherwise.

getGroupsOfParameters

public List<GroupOfParameters> getGroupsOfParameters()

Description copied from interface: SilverpeasComponent

Gets groups of parameters.

Returns:

the list of groups of parameters.