Package org.silverpeas.core.workflow.api.model

Interface Input

  • All Superinterfaces:
    Column
    All Known Implementing Classes:
    ItemRef
    public interface Input
extends Column
    Interface describing a representation of the <input> element of a Process Model.

    • Method Detail

      • isReadonly

        boolean isReadonly()
        Get the read-only attribute of this input
        Returns:
        true if input is read-only

      • setReadonly

        void setReadonly​(boolean readonly)
        Set the readonly attribute

      • isMandatory

        boolean isMandatory()
        Get value of mandatory attribute
        Returns:
        true if item must be filled

      • setMandatory

        void setMandatory​(boolean mandatory)
        Set value of mandatory attribute
        Parameters:
        mandatory - true if item must be filled

      • getDisplayerName

        String getDisplayerName()
        Get name of displayer used to show the item
        Returns:
        displayer name

      • setDisplayerName

        void setDisplayerName​(String displayerName)
        Set name of displayer used to show the item
        Parameters:
        displayerName - displayer name

      • getValue

        String getValue()
        Get default value
        Returns:
        default value

      • setValue

        void setValue​(String value)
        Set default value
        Parameters:
        value - default value

      • getLabels

        ContextualDesignations getLabels()
        Get all the labels
        Returns:
        an object containing the collection of the labels

      • getLabel

        String getLabel​(String role,
                String language)
        Get label in specific language for the given role
        Parameters:
        language - label's language
        role - role for which the label is
        Returns:
        wanted label as a String object. If label is not found, search label with given role and default language, if not found again, return the default label in given language, if not found again, return the default label in default language, if not found again, return empty string.