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

Interface Action

  • All Known Implementing Classes:
    ActionImpl
    public interface Action
    Interface describing a representation of the <action> element of a Process Model.

    • Method Detail

      • getName

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

      • setName

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

      • getKind

        String getKind()
        Get the kind of this action
        Returns:
        action's kind

      • setKind

        void setKind​(String kind)
        Set the kind of this action
        Parameters:
        kind - an instance of Kind object

      • getDescription

        String getDescription​(String role,
                      String language)
        Get description in specific language for the given role
        Parameters:
        role - role for which the description is
        language - description's language
        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:
        role - role for which the label is
        language - label's language
        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

      • setAllowedUsers

        void setAllowedUsers​(QualifiedUsers allowedUsers)
        Set the list of users allowed to execute this action
        Parameters:
        allowedUsers - allowed users

      • getAllowedUsers

        QualifiedUsers getAllowedUsers()
        Get all the users allowed to execute this action
        Returns:
        an array of User objects

      • getConsequences

        Consequences getConsequences()
        Get all the consequences of this action
        Returns:
        Consequences objects

      • createConsequences

        Consequences createConsequences()
        Create and return and object implementing Consequences

      • setConsequences

        void setConsequences​(Consequences consequences)
        Set the consequences of this action
        Parameters:
        consequences - the consequences

      • getForm

        Form getForm()
        Get the form associated with this action
        Returns:
        Form object

      • setForm

        void setForm​(Form form)
        Set the form associated with this action
        Parameters:
        form - instance of Form object