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

Class 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).

    • Constructor Detail

      • WAComponent

        public WAComponent()

    • 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 is String

      • setBehaviors

        public void setBehaviors​(ComponentBehaviors value)
        Sets all the behaviors this component has to satisfy.
        Parameters:
        value - allowed object is ComponentBehaviors

      • 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 is Multilang

      • 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 is Multilang

      • 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 is Multilang

      • 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 is Boolean

      • 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 is String

      • 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 of Profile

      • 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 of Parameter

      • 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.

      • getGroupsOfParameters

        public List<GroupOfParameters> getGroupsOfParameters()
        Description copied from interface: SilverpeasComponent
        Gets groups of parameters.
        Returns:
        the list of groups of parameters.

      • 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.