com.silverpeas.workflow.api.model
Interface Participants

All Known Implementing Classes:

ParticipantsImpl

public interface Participants

Interface describing a representation of the <participants> element of a Process Model.

Method Summary

void	addParticipant(Participant participant) Add an participant to the collection
Participant	createParticipant() Create an Participant
Participant	getParticipant(String name) Get the participant definition with given name
Participant[]	getParticipants() Returns all the Participant elements as an array
Iterator<Participant>	iterateParticipant() Iterate through the Participant objects
void	removeParticipant(String strParticipantName) Remove an participant from the collection

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:

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.