All Known Implementing Classes:

AbstractSilverpeasComponent, PersonalComponent, Tool, WAComponent
```
public interface SilverpeasComponent
```
A component in Silverpeas. It is either a multi-user application or a personal application.

Author:

Yohann Chastagnier

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default ParameterList`	`getAllParameters()`	Gets same parameters as `getParameters()` but filled into structured object `ParameterList`.
`static Optional<SilverpeasComponent>`	`getByInstanceId(String componentInstanceId)`	Gets a silverpeas component from the specified component instance identifier.
`static Optional<SilverpeasComponent>`	`getByName(String componentName)`	Gets a silverpeas component from the specified name.
`Map<String,String>`	`getDescription()`	Gets the value of the description property.
`default String`	`getDescription(String lang)`	Gets the value of the description property according to a given language.
`List<GroupOfParameters>`	`getGroupsOfParameters()`	Gets groups of parameters.
`Map<String,String>`	`getLabel()`	Gets the value of the label property.
`default String`	`getLabel(String lang)`	Gets the value of the label property according to a given language.
`String`	`getName()`	Gets the type of the component.
`List<Parameter>`	`getParameters()`	Gets the value of the parameters property.
`List<Parameter>`	`getSortedParameters()`	Gets same parameters as `getParameters()`, sorted by order and name.
`boolean`	`hasParameterDefined(String parameterName)`	Indicates if a parameter is defined which name is equal to the given method parameter.
`default boolean`	`isPersonal()`	Indicates if the component instance is a personal one. A personal component instance is linked to a user.
`default boolean`	`isTopicTracker()`	Is this component is a topic tracker?
`boolean`	`isVisible()`	Gets the value of the visible property.
`default boolean`	`isWorkflow()`	Is this component is a workflow?

- Method Detail
  - getByName
```
static Optional<SilverpeasComponent> getByName(String componentName)
```
    Gets a silverpeas component from the specified name.
    
    Parameters:
    
    componentName - a component name.
    
    Returns:
    
    an optional silverpeas component of SilverpeasComponent.
  - getByInstanceId
```
static Optional<SilverpeasComponent> getByInstanceId(String componentInstanceId)
```
    Gets a silverpeas component from the specified component instance identifier.
    
    Parameters:
    
    componentInstanceId - a component instance identifier as string.
    
    Returns:
    
    an optional silverpeas component of SilverpeasComponent.
  - getName
```
String getName()
```
    Gets the type of the component.
    
    Returns:
    
    the application name.
  - getLabel
```
Map<String,String> getLabel()
```
    Gets the value of the label property.
    
    Returns:
    
    possible object is Multilang
  - getLabel
```
default String getLabel(String lang)
```
    Gets the value of the label property according to a given language.
    
    Parameters:
    
    lang - the language into which the label must be translated.
    
    Returns:
    
    possible object is Multilang
  - getDescription
```
Map<String,String> getDescription()
```
    Gets the value of the description property.
    
    Returns:
    
    possible object is Multilang
  - getDescription
```
default String getDescription(String lang)
```
    Gets the value of the description property according to a given language.
    
    Parameters:
    
    lang - the language into which the description must be translated.
    
    Returns:
    
    possible object is Multilang
  - isPersonal
```
default boolean isPersonal()
```
    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.
  - isVisible
```
boolean isVisible()
```
    Gets the value of the visible property.
  - getParameters
```
List<Parameter> getParameters()
```
    Gets the value of the parameters property.
    
    Returns:
    
    list of Parameter
  - hasParameterDefined
```
boolean hasParameterDefined(String parameterName)
```
    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.
  - getSortedParameters
```
List<Parameter> getSortedParameters()
```
    Gets same parameters as getParameters(), sorted by order and name.
    
    Returns:
    
    sorted parameters.
  - getAllParameters
```
default ParameterList getAllParameters()
```
    Gets same parameters as getParameters() but filled into structured object ParameterList.
    
    Returns:
    
    parameters contained into ParameterList instance.
  - getGroupsOfParameters
```
List<GroupOfParameters> getGroupsOfParameters()
```
    Gets groups of parameters.
    
    Returns:
    
    the list of groups of parameters.
  - isWorkflow
```
default boolean isWorkflow()
```
    Is this component is a workflow?
    
    Returns:
    
    true if this component satisfies the behavior of a workflow, that is to say if it defines a workflow. False if it is a regular Silverpeas. application.
  - isTopicTracker
```
default boolean isTopicTracker()
```
    Is this component is a topic tracker?
    
    Returns:
    
    true if this component satisfies the behavior of a topic tracker.

Interface SilverpeasComponent

Method Summary

Method Detail

getByName

getByInstanceId

getName

getLabel

getLabel

getDescription

getDescription

isPersonal

isVisible

getParameters

hasParameterDefined

getSortedParameters

getAllParameters

getGroupsOfParameters

isWorkflow

isTopicTracker