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

Class AbstractSilverpeasComponent

java.lang.Object

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

All Implemented Interfaces:

SilverpeasComponent

Direct Known Subclasses:

PersonalComponent, Tool, WAComponent

public abstract class AbstractSilverpeasComponent
extends Object
implements SilverpeasComponent

Author:

mmoquillon

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,Parameter>	indexedParametersByName

Constructor Summary

Constructors

Constructor	Description
AbstractSilverpeasComponent()

Method Summary

Modifier and Type	Method	Description
protected abstract Map<String,String>	getDescription()	Gets the value of the description property.
String	getDescription(String lang)	Gets the value of the description property according to a given language.
protected Map<String,Parameter>	getIndexedParametersByName()	Gets defined parameters indexed by their names.
protected abstract Map<String,String>	getLabel()	Gets the value of the label property.
String	getLabel(String lang)	Gets the value of the label property according to a given language.
List<GroupOfParameters>	getSortedGroupsOfParameters()	Gets same parameters as SilverpeasComponent.getGroupsOfParameters(), sorted by order and name.
List<Parameter>	getSortedParameters()	Gets same parameters as SilverpeasComponent.getParameters(), sorted by order and name.

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, getGroupsOfParameters, getName, getParameters, hasParameterDefined, isInheritSpaceRightsByDefault, isPersonal, isPublicByDefault, isTopicTracker, isVisible, isWorkflow

Field Detail

indexedParametersByName

protected Map<String,Parameter> indexedParametersByName

Constructor Detail

AbstractSilverpeasComponent

public AbstractSilverpeasComponent()

Method Detail

getLabel

protected abstract Map<String,String> getLabel()

Gets the value of the label property.

Returns:

possible object is Multilang

getLabel

public String getLabel(String lang)

Description copied from interface: SilverpeasComponent

Gets the value of the label property according to a given language.

Specified by:

getLabel in interface SilverpeasComponent

Parameters:

lang - the language into which the label must be translated.

Returns:

possible object is Multilang

getDescription

protected abstract Map<String,String> getDescription()

Gets the value of the description property.

Returns:

possible object is Multilang

getDescription

public String getDescription(String lang)

Description copied from interface: SilverpeasComponent

Gets the value of the description property according to a given language.

Specified by:

getDescription in interface SilverpeasComponent

Parameters:

lang - the language into which the description must be translated.

Returns:

possible object is Multilang

getIndexedParametersByName

protected Map<String,Parameter> getIndexedParametersByName()

Gets defined parameters indexed by their names.

Returns:

a dictionary with all the parameters indexed by their name.

getSortedParameters

public List<Parameter> getSortedParameters()

Description copied from interface: SilverpeasComponent

Gets same parameters as SilverpeasComponent.getParameters(), sorted by order and name.

Specified by:

getSortedParameters in interface SilverpeasComponent

Returns:

sorted parameters.

getSortedGroupsOfParameters

public List<GroupOfParameters> getSortedGroupsOfParameters()

Description copied from interface: SilverpeasComponent

Gets same parameters as SilverpeasComponent.getGroupsOfParameters(), sorted by order and name.

Specified by:

getSortedGroupsOfParameters in interface SilverpeasComponent

Returns:

sorted groups of parameters.