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

Interface Participants

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    ParticipantsImpl
    public interface Participants
extends Serializable
    Interface describing a representation of the <participants> element of a Process Model.

    • Method Detail

      • iterateParticipant

        Iterator<Participant> iterateParticipant()
        Iterate through the Participant objects
        Returns:
        an iterator

      • createParticipant

        Participant createParticipant()
        Create an Participant
        Returns:
        an object implementing Participant

      • addParticipant

        void addParticipant​(Participant participant)
        Add an participant to the collection
        Parameters:
        participant - to be added

      • getParticipants

        Participant[] getParticipants()
        Returns all the Participant elements as an array
        Returns:
        an array with the participants.

      • getParticipant

        Participant getParticipant​(String name)
        Get the participant definition with given name
        Parameters:
        name - participant name
        Returns:
        wanted participant definition

      • removeParticipant

        void removeParticipant​(String strParticipantName)
                throws WorkflowException
        Remove an participant from the collection
        Parameters:
        strParticipantName - the name of the participant to be removed.
        Throws:
        WorkflowException - when the participant could not be deleted.