com.silverpeas.workflow.api.model
Interface Roles

All Known Implementing Classes:

RolesImpl

public interface Roles

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

Method Summary

void	addRole(Role role) Add an role to the collection
Role	createRole() Create a Role
Role	getRole(String name) Get the role definition with given name
Role[]	getRoles() Get the roles definition
Iterator<Role>	iterateRole() Iterate through the Role objects
void	removeRole(String strRoleName) Remove an role from the collection

Method Detail

iterateRole

Iterator<Role> iterateRole()

Iterate through the Role objects

Returns:

an iterator

createRole

Role createRole()

Create a Role

Returns:

an object implementing Role

addRole

void addRole(Role role)

Add an role to the collection

Parameters:

role - to be added

getRoles

Role[] getRoles()

Get the roles definition

Returns:

roles definition

getRole

Role getRole(String name)

Get the role definition with given name

Parameters:

name - role name

Returns:

wanted role definition

removeRole

void removeRole(String strRoleName)
                throws WorkflowException

Remove an role from the collection

Parameters:

strRoleName - the name of the role to be removed.

Throws:

WorkflowException - if the role cannot be found.