//----------------------------BEGIN LICENSE----------------------------
/* 
 * Willow : the Open Source WorkFlow Project
 * Distributable under GNU LGPL license by gun.org
 *
 * Copyright (C) 2004-2010 huihoo.org 
 * Copyright (C) 2004-2010  ZosaTapo <dertyang@hotmail.com> 
 * 
 * ====================================================================
 * Project Homepage : http://www.huihoo.org/willow
 * Source Forge     : http://sourceforge.net/projects/huihoo
 * Mailing list     : willow@lists.sourceforge.net 
 */
//----------------------------END  LICENSE-----------------------------
package org.huihoo.workflow.usermodel;

import java.util.Iterator;

import org.huihoo.workflow.WorkflowComplexComponent;


public abstract class WorkflowRole extends WorkflowComplexComponent
{
	/** 
	 * Construct a new WorkflowComponenet.
	 */
	protected WorkflowRole()
	{
		this(null,null);
	}
	
	/** 
	 * Construct a new WorkflowComponenet.
	 *
	 * @param uuid_ The element ID
	 * @param name The element name
	 */
	protected WorkflowRole(String uuid, String name)
	{
		this(uuid, name, null);
	}

	/** 
	 * Construct a new WorkflowComponenet.
	 *
	 * @param uuid_       The element ID
	 * @param name        The element name
	 * @param description The element description
	 */
	protected WorkflowRole(String uuid_, String name, String description)
	{
		super(uuid_, name, description);
	}
	
	// ------------------------------------------------------------- Properties
	 /**
		* Return the set of {@link WorkflowParticipant}s that are members of this role.
		*/
	 public abstract Iterator getParticipants();
	
	 // --------------------------------------------------------- Public Method
	 /**
		* Add a new {@link WorkflowParticipant} to this role.
		*
		* @param user The new user
		*/
	 public abstract void addPaticipant(WorkflowParticipant user);
  
	 /**
		* Remove a {@link WorkflowParticipant} from this role.
		*
		* @param user The old user
		*/
	 public abstract void removeParticipant(WorkflowParticipant user);


	 /**
		* Remove all {@link WorkflowParticipant}s from this role.
		*/
	 public abstract  void removeParticipants();
 
}
