Class WAComponent
- java.lang.Object
-
- org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent
-
- org.silverpeas.core.admin.component.model.WAComponent
-
- All Implemented Interfaces:
SilverpeasComponent
public class WAComponent extends AbstractSilverpeasComponent
WAComponent stands for Web Application Component and it represents an application that is available in Silverpeas and that can be instantiated to a
ComponentInst
object.The Web Application components available in Silverpeas are loaded by the
org.silverpeas.core.admin.component.WAComponentRegistry
registry. They can be the accessed either by the registry itself or by the WAComponent class (it delegates the access to the registry).
-
-
Field Summary
Fields Modifier and Type Field Description protected ComponentBehaviors
behaviors
protected Map<String,String>
description
protected List<GroupOfParameters>
groupsOfParameters
protected Map<String,String>
label
protected String
name
protected List<Parameter>
parameters
protected boolean
portlet
protected List<Profile>
profiles
protected String
router
protected Map<String,String>
suite
protected boolean
visible
protected boolean
visibleInPersonalSpace
-
Fields inherited from class org.silverpeas.core.admin.component.model.AbstractSilverpeasComponent
indexedParametersByName
-
-
Constructor Summary
Constructors Constructor Description WAComponent()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Collection<WAComponent>
getAll()
Gets all the available WAComponent instances.ComponentBehaviors
getBehaviors()
Gets the different behaviors this component satisfies.static Optional<WAComponent>
getByInstanceId(String componentInstanceId)
Gets the WAComponent object representing the component to which the specified instance is related.static Optional<WAComponent>
getByName(String componentName)
Gets the WAComponent object 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 value of the name property.List<Parameter>
getParameters()
Gets the value of the parameters property.Profile
getProfile(String name)
List<Profile>
getProfiles()
Gets the value of the profiles property.String
getRouter()
Gets the value of the router property.List<GroupOfParameters>
getSortedGroupsOfParameters()
List<Parameter>
getSortedParameters()
Gets same parameters asSilverpeasComponent.getParameters()
, sorted by order and name.Map<String,String>
getSuite()
Gets the value of the suite property.String
getSuite(String lang)
boolean
hasParameterDefined(String parameterName)
Indicates if a parameter is defined which name is equal to the given method parameter.boolean
isPortlet()
Gets the value of the portlet property.boolean
isTopicTracker()
Is this component is a topic tracker?boolean
isVisible()
Gets the value of the visible property.boolean
isVisibleInPersonalSpace()
Gets the value of the visibleInPersonalSpace property.boolean
isWorkflow()
Is this component is a workflow?void
setBehaviors(ComponentBehaviors value)
Sets all the behaviors this component has to satisfy.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
setPortlet(boolean value)
Sets the value of the portlet property.void
setProfiles(List<Profile> profiles)
Sets the value of the profiles property.void
setRouter(String value)
Sets the value of the router property.void
setSuite(Map<String,String> value)
Sets the value of the suite property.void
setVisible(boolean value)
Sets the value of the visible property.void
setVisibleInPersonalSpace(boolean value)
Sets the value of the visibleInPersonalSpace 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, isPersonal
-
-
-
-
Field Detail
-
name
protected String name
-
behaviors
protected ComponentBehaviors behaviors
-
visible
protected boolean visible
-
visibleInPersonalSpace
protected boolean visibleInPersonalSpace
-
portlet
protected boolean portlet
-
router
protected String router
-
groupsOfParameters
protected List<GroupOfParameters> groupsOfParameters
-
-
Method Detail
-
getByName
public static Optional<WAComponent> getByName(String componentName)
Gets the WAComponent object with the specified name.- Parameters:
componentName
- the unique name of the WAComponent to return.- Returns:
- optionally a WAComponent instance with the given name.
-
getByInstanceId
public static Optional<WAComponent> getByInstanceId(String componentInstanceId)
Gets the WAComponent object representing the component to which the specified instance is related.- Parameters:
componentInstanceId
- the unique identifier of a component instance.- Returns:
- optionally a WAComponent object related to the component instance.
-
getAll
public static Collection<WAComponent> getAll()
Gets all the available WAComponent instances.- Returns:
- a collection of WAComponent instance.
-
getName
public String getName()
Gets the value of the name property.- Returns:
- possible object is
String
-
setName
public void setName(String value)
Sets the value of the name property.- Parameters:
value
- allowed object isString
-
getBehaviors
public ComponentBehaviors getBehaviors()
Gets the different behaviors this component satisfies.- Returns:
- possible object is
ComponentBehaviors
-
setBehaviors
public void setBehaviors(ComponentBehaviors value)
Sets all the behaviors this component has to satisfy.- Parameters:
value
- allowed object isComponentBehaviors
-
getLabel
public Map<String,String> getLabel()
Gets the value of the label property.- Returns:
- possible object is
Multilang
-
setLabel
public void setLabel(Map<String,String> value)
Sets the value of the label property.- Parameters:
value
- allowed object isMultilang
-
getDescription
public Map<String,String> getDescription()
Gets the value of the description property.- Returns:
- possible object is
Multilang
-
setDescription
public void setDescription(Map<String,String> value)
Sets the value of the description property.- Parameters:
value
- allowed object isMultilang
-
getSuite
public Map<String,String> getSuite()
Gets the value of the suite property.- Returns:
- possible object is
Multilang
-
setSuite
public void setSuite(Map<String,String> value)
Sets the value of the suite property.- Parameters:
value
- allowed object isMultilang
-
isVisible
public boolean isVisible()
Gets the value of the visible property.
-
setVisible
public void setVisible(boolean value)
Sets the value of the visible property.
-
isVisibleInPersonalSpace
public boolean isVisibleInPersonalSpace()
Gets the value of the visibleInPersonalSpace property.- Returns:
- possible object is
Boolean
-
setVisibleInPersonalSpace
public void setVisibleInPersonalSpace(boolean value)
Sets the value of the visibleInPersonalSpace property.- Parameters:
value
- allowed object isBoolean
-
isPortlet
public boolean isPortlet()
Gets the value of the portlet property.
-
setPortlet
public void setPortlet(boolean value)
Sets the value of the portlet property.
-
getRouter
public String getRouter()
Gets the value of the router property.- Returns:
- possible object is
String
-
setRouter
public void setRouter(String value)
Sets the value of the router property.- Parameters:
value
- allowed object isString
-
getProfiles
public List<Profile> getProfiles()
Gets the value of the profiles property.- Returns:
- list of
Profile
-
setProfiles
public void setProfiles(List<Profile> profiles)
Sets the value of the profiles property.- Parameters:
profiles
- list ofProfile
-
getParameters
public List<Parameter> getParameters()
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)
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()
-
isWorkflow
public boolean isWorkflow()
Description copied from interface:SilverpeasComponent
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
public boolean isTopicTracker()
Description copied from interface:SilverpeasComponent
Is this component is a topic tracker?- Returns:
- true if this component satisfies the behavior of a topic tracker.
-
-