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

Class Tool

  • All Implemented Interfaces:
    SilverpeasComponent
    public class Tool
extends AbstractSilverpeasComponent

    A tool represents an application that is available in Silverpeas personal space.

    The tools available in Silverpeas are loaded by the org.silverpeas.core.admin.component .ToolRegistry registry. They can be the accessed either by the registry itself or by the Tool class (it delegates the access to the registry).

    • Field Detail

      • id

        protected final String id

    • Constructor Detail

      • Tool

        public Tool​(String id)

    • Method Detail

      • getById

        public static Optional<Tool> getById​(String toolId)
        Gets the Tool instance with the specified id.
        Parameters:
        toolId - the unique id (or unique id) of the Tool to return.
        Returns:
        optionally a Tool instance with the given id.

      • getAll

        public static Collection<Tool> getAll()
        Gets all the available Tool instances.
        Returns:
        a collection of Tool instance.

      • getName

        public String getName()
        Description copied from interface: SilverpeasComponent
        Gets the type of the component.
        Returns:
        the application name.

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

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

      • getGroupsOfParameters

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