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

Interface Item

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    ItemImpl
    public interface Item
extends Serializable
    Interface describing a representation of the <item> element of a Process Model.

    • Method Detail

      • getName

        String getName()
        Get the name of this item
        Returns:
        item's name

      • setName

        void setName​(String name)
        Set the name of this item
        Parameters:
        name - item 's name

      • getDescription

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

      • getDescriptions

        ContextualDesignations getDescriptions()
        Get all the descriptions
        Returns:
        an object containing the collection of the descriptions

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

      • getLabels

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

      • isComputed

        boolean isComputed()
        Get value of computed attribute
        Returns:
        true if item must be computed

      • setComputed

        void setComputed​(boolean computed)
        Set value of computed attribute
        Parameters:
        computed - true if item must be computed

      • getFormula

        String getFormula()
        Get formula to use if item must be computed
        Returns:
        formula of type 'action.Validation.actor'

      • setFormula

        void setFormula​(String formula)
        Set formula to use if item must be computed
        Parameters:
        formula - formula of type 'action.Validation.actor'

      • isReadonly

        boolean isReadonly()
        Get value of readOnly attribute
        Returns:
        true if item must be readonly

      • setReadonly

        void setReadonly​(boolean readonly)
        Set value of readOnly attribute
        Parameters:
        readonly - true if item must be readonly

      • getType

        String getType()
        Get the type of this item
        Returns:
        item's type (text for text field)

      • setType

        void setType​(String type)
        Set the type of this item
        Parameters:
        type - item 's type (text for text field)

      • getMapTo

        String getMapTo()
        Get the full user field name, to which this item is map
        Returns:
        full user field name

      • setMapTo

        void setMapTo​(String mapTo)
        Set the full user field name, to which this item is map
        Parameters:
        mapTo - full user field name

      • getParameter

        Parameter getParameter​(String strName)
        Get the parameter specified by name
        Parameters:
        strName - the parameter name
        Returns:
        the parameters

      • createParameter

        Parameter createParameter()
        Create an object implementing Parameter
        Returns:
        a new parameter.

      • addParameter

        void addParameter​(Parameter parameter)
        Add a Parameter to the collection
        Parameters:
        parameter - the parameter to add in this item.

      • iterateParameter

        Iterator<Parameter> iterateParameter()
        Return an Iterator over the parameters collection
        Returns:
        an iterator over the parameters of this item.

      • removeParameter

        void removeParameter​(String strName)
              throws WorkflowException
        Remove the parameter specified by its name
        Parameters:
        strName - the name of the parameter
        Throws:
        WorkflowException - when the parameter cannot be found

      • getKeyValuePairs

        Map<String,​String> getKeyValuePairs()
        Gets the parameters as a dictionary of keys to values.
        Returns:
        a Map with all the parameters with as key the parameter name and value the parameter value.