Class PersonalComponent
- java.lang.Object
-
- org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent
-
- org.silverpeas.core.admin.component.model.PersonalComponent
-
- All Implemented Interfaces:
SilverpeasComponent
public class PersonalComponent extends AbstractSilverpeasComponent
UserComponent stands for Web Application Component associated to users and it represents an application that is available in Silverpeas personal space.
The Web Application user components available in Silverpeas are loaded by the
org.silverpeas.core.admin.component.PersonalComponentRegistry
registry. They can be the accessed either by the registry itself or by the PersonalComponent class (it delegates the access to the registry).
-
-
Field Summary
Fields Modifier and Type Field Description protected Map<String,String>
description
protected List<GroupOfParameters>
groupsOfParameters
protected Map<String,String>
label
protected String
name
protected List<Parameter>
parameters
protected boolean
visible
-
Fields inherited from class org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent
indexedParametersByName
-
-
Constructor Summary
Constructors Constructor Description PersonalComponent()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Collection<PersonalComponent>
getAll()
Gets all the available PersonalComponent instances.static Optional<PersonalComponent>
getByInstanceId(String componentInstanceId)
Gets the PersonalComponent object representing the component to which the specified instance is related.static Optional<PersonalComponent>
getByName(String componentName)
Gets the PersonalComponent instance with the specified name.Map<String,String>
getDescription()
Gets the value of the description property.List<GroupOfParameters>
getGroupsOfParameters()
Gets groups of parameters.Map<String,String>
getLabel()
Gets the value of the label property.String
getName()
Gets the type of the component.List<Parameter>
getParameters()
Gets the value of the parameters property.List<GroupOfParameters>
getSortedGroupsOfParameters()
List<Parameter>
getSortedParameters()
Gets same parameters asSilverpeasComponent.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.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.void
setDescription(Map<String,String> value)
Sets the value of the description property.void
setLabel(Map<String,String> value)
Sets the value of the label property.void
setName(String value)
Sets the value of the name property.void
setParameters(List<Parameter> parameters)
Sets the value of the parameters property.void
setVisible(boolean value)
Sets the value of the visible property.-
Methods inherited from class org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent
getIndexedParametersByName
-
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, getDescription, getLabel, isTopicTracker, isWorkflow
-
-
-
-
Method Detail
-
getByName
public static Optional<PersonalComponent> getByName(String componentName)
Gets the PersonalComponent instance with the specified name.- Parameters:
componentName
- the unique name of the PersonalComponent to return.- Returns:
- optionally a PersonalComponent instance with the given name.
-
getByInstanceId
public static Optional<PersonalComponent> getByInstanceId(String componentInstanceId)
Gets the PersonalComponent object representing the component to which the specified instance is related.- Parameters:
componentInstanceId
- the unique identifier of a personal component instance.- Returns:
- optionally a PersonalComponent object related to the personal component instance.
-
getAll
public static Collection<PersonalComponent> getAll()
Gets all the available PersonalComponent instances.- Returns:
- a collection of PersonalComponent instance.
-
getName
public String getName()
Description copied from interface:SilverpeasComponent
Gets the type of the component.- Returns:
- the application name.
-
getLabel
public Map<String,String> getLabel()
Description copied from interface:SilverpeasComponent
Gets the value of the label property.- Returns:
- possible object is
Multilang
-
setName
public void setName(String value)
Sets the value of the name property.- Parameters:
value
- allowed object isString
-
setLabel
public void setLabel(Map<String,String> value)
Sets the value of the label property.- Parameters:
value
- allowed object isMultilang
-
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.
-
setDescription
public void setDescription(Map<String,String> value)
Sets the value of the description property.- Parameters:
value
- allowed object isMultilang
-
getDescription
public Map<String,String> getDescription()
Description copied from interface:SilverpeasComponent
Gets the value of the description property.- Returns:
- possible object is
Multilang
-
setVisible
public void setVisible(boolean value)
Sets the value of the visible property.
-
getParameters
public List<Parameter> getParameters()
Description copied from interface:SilverpeasComponent
Gets the value of the parameters property.- Returns:
- list of
Parameter
-
setParameters
public void setParameters(List<Parameter> parameters)
Sets the value of the parameters property.- Parameters:
parameters
- list ofParameter
-
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.
-
getSortedParameters
public List<Parameter> getSortedParameters()
Description copied from interface:SilverpeasComponent
Gets same parameters asSilverpeasComponent.getParameters()
, sorted by order and name.- Returns:
- sorted parameters.
-
getGroupsOfParameters
public List<GroupOfParameters> getGroupsOfParameters()
Description copied from interface:SilverpeasComponent
Gets groups of parameters.- Returns:
- the list of groups of parameters.
-
getSortedGroupsOfParameters
public List<GroupOfParameters> getSortedGroupsOfParameters()
-
-