org.yawlfoundation.yawl.resourcing

Class TaskPrivileges

java.lang.Object

org.yawlfoundation.yawl.resourcing.TaskPrivileges

public class TaskPrivileges
extends java.lang.Object

Maps each of a set of User-Task Privileges to a set of Participants (if any) for one particular task. The mappings are listed in the specification file, and may map a privilege to individual participants and/or all the participants that fulfil a certain Role or Roles.

Author:

Michael Adams v0.1, 13/08/2007

Last Date: 20/09/2007

Field Summary

Fields

Modifier and Type	Field and Description
static int	CAN_DEALLOCATE
static int	CAN_DELEGATE
static int	CAN_PILE
static int	CAN_REALLOCATE_STATEFUL
static int	CAN_REALLOCATE_STATELESS
static int	CAN_SKIP
static int	CAN_SUSPEND

Constructor Summary

Constructors

Constructor and Description
TaskPrivileges() **************************************************************************
TaskPrivileges(java.lang.String taskID)
TaskPrivileges(YSpecificationID specID, java.lang.String taskID)

Method Summary

Modifier and Type	Method and Description
void	addParticipantToPrivilegeUnchecked(java.lang.String pid, int priv) grant the privilege to the Participant without checking the validity of the id.
void	addRoleToPrivilegeUnchecked(java.lang.String rid, int priv) grant the privilege to the Role without checking the validity of the id.
void	allowAll(int privilege) grant a privilege to all Participants
void	allowAll(java.lang.String privilegeStr)
boolean	canDeallocate(Participant p)
boolean	canDelegate(Participant p)
boolean	canPile(Participant p)
boolean	canReallocateStateful(Participant p)
boolean	canReallocateStateless(Participant p)
boolean	canSkip(Participant p)
boolean	canSuspend(Participant p) Convenience boolean methods - return true if the Particpant passed has been granted the privilege
void	disallowAll(int privilege) disallow a privilege for all Participants
void	disallowAll(java.lang.String privilegeStr)
int	getPrivilegeType(java.lang.String privStr) returns the privilege type for the string version passed
YSpecificationID	getSpecID()
java.lang.String	getTaskID()
void	grant(int priv, Participant p) Grants a privilege to a Participant
void	grant(int priv, java.util.Set<Participant> pSet) Grants a privilege to set of Participant
void	grant(int priv, java.lang.String id) Grants the privilege the Participant with id passed
void	grant(java.lang.String privName, Participant p)
void	grant(java.lang.String privName, java.util.Set<Participant> pSet)
void	grantByID(int priv, java.util.Set pSet) Grants a privilege to set of Participant using a set of ids
void	grantDeallocate(Participant p)
void	grantDeallocate(java.util.Set<Participant> p)
void	grantDeallocateByID(java.util.Set userids)
void	grantDeallocateByID(java.lang.String userid)
void	grantDelegate(Participant p)
void	grantDelegate(java.util.Set<Participant> p)
void	grantDelegateByID(java.util.Set userids)
void	grantDelegateByID(java.lang.String userid)
void	grantPile(Participant p)
void	grantPile(java.util.Set<Participant> p)
void	grantPileByID(java.util.Set userids)
void	grantPileByID(java.lang.String userid)
void	grantReallocateStateful(Participant p)
void	grantReallocateStateful(java.util.Set<Participant> p)
void	grantReallocateStatefulByID(java.util.Set userids)
void	grantReallocateStatefulByID(java.lang.String userid)
void	grantReallocateStateless(Participant p)
void	grantReallocateStateless(java.util.Set<Participant> p)
void	grantReallocateStatelessByID(java.util.Set userids)
void	grantReallocateStatelessByID(java.lang.String userid)
void	grantSkip(Participant p)
void	grantSkip(java.util.Set<Participant> p)
void	grantSkipByID(java.util.Set userids)
void	grantSkipByID(java.lang.String userid)
void	grantSuspend(Participant p) Convenience grant methods (by Participant, id, Participant set, id Set)
void	grantSuspend(java.util.Set<Participant> p)
void	grantSuspendByID(java.util.Set userids)
void	grantSuspendByID(java.lang.String userid)
boolean	hasParticipants(int priv) returns true if at least one Participant has been granted the Privilege
boolean	hasPrivilege(Participant p, int privilege) returns true if the Participant has been granted the Privilege
void	parse(Element e, Namespace nsYawl) Parses the xml element passed into a set of privileges and who has them
void	setSpecID(YSpecificationID specID)
void	setTaskID(java.lang.String taskID)
java.lang.String	toXML() creates xml to describe the entire object
java.lang.String	toXML(boolean full)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CAN_SUSPEND

public static final int CAN_SUSPEND

See Also:

Constant Field Values

CAN_REALLOCATE_STATELESS

public static final int CAN_REALLOCATE_STATELESS

See Also:

Constant Field Values

CAN_REALLOCATE_STATEFUL

public static final int CAN_REALLOCATE_STATEFUL

See Also:

Constant Field Values

CAN_DEALLOCATE

public static final int CAN_DEALLOCATE

See Also:

Constant Field Values

CAN_DELEGATE

public static final int CAN_DELEGATE

See Also:

Constant Field Values

CAN_SKIP

public static final int CAN_SKIP

See Also:

Constant Field Values

CAN_PILE

public static final int CAN_PILE

See Also:

Constant Field Values

Constructor Detail

TaskPrivileges

public TaskPrivileges()

**************************************************************************

TaskPrivileges

public TaskPrivileges(java.lang.String taskID)

TaskPrivileges

public TaskPrivileges(YSpecificationID specID,
                      java.lang.String taskID)

Method Detail

getSpecID

public YSpecificationID getSpecID()

setSpecID

public void setSpecID(YSpecificationID specID)

getTaskID

public java.lang.String getTaskID()

setTaskID

public void setTaskID(java.lang.String taskID)

getPrivilegeType

public int getPrivilegeType(java.lang.String privStr)

returns the privilege type for the string version passed

grant

public void grant(int priv,
                  java.lang.String id)

Grants the privilege the Participant with id passed

Parameters:

priv - the privilege to grant

id - the id of the Participant (must be a known Participant id)

grant

public void grant(int priv,
                  Participant p)

Grants a privilege to a Participant

Parameters:

priv - the privilege to grant

p - the Participant

grant

public void grant(java.lang.String privName,
                  Participant p)

grant

public void grant(int priv,
                  java.util.Set<Participant> pSet)

Grants a privilege to set of Participant

Parameters:

priv - the privilege to grant

pSet - the Participant Set

grant

public void grant(java.lang.String privName,
                  java.util.Set<Participant> pSet)

grantByID

public void grantByID(int priv,
                      java.util.Set pSet)

Grants a privilege to set of Participant using a set of ids

Parameters:

priv - the privilege to grant

pSet - the Set of Participant ids

allowAll

public void allowAll(int privilege)

grant a privilege to all Participants

allowAll

public void allowAll(java.lang.String privilegeStr)

disallowAll

public void disallowAll(int privilege)

disallow a privilege for all Participants

disallowAll

public void disallowAll(java.lang.String privilegeStr)

addParticipantToPrivilegeUnchecked

public void addParticipantToPrivilegeUnchecked(java.lang.String pid,
                                               int priv)

grant the privilege to the Participant without checking the validity of the id. Written to allow the editor to generate specification xml

addRoleToPrivilegeUnchecked

public void addRoleToPrivilegeUnchecked(java.lang.String rid,
                                        int priv)

grant the privilege to the Role without checking the validity of the id. Written to allow the editor to generate specification xml

grantSuspend

public void grantSuspend(Participant p)

Convenience grant methods (by Participant, id, Participant set, id Set)

grantReallocateStateless

public void grantReallocateStateless(Participant p)

grantReallocateStateful

public void grantReallocateStateful(Participant p)

grantDeallocate

public void grantDeallocate(Participant p)

grantDelegate

public void grantDelegate(Participant p)

grantSkip

public void grantSkip(Participant p)

grantPile

public void grantPile(Participant p)

grantSuspend

public void grantSuspend(java.util.Set<Participant> p)

grantReallocateStateless

public void grantReallocateStateless(java.util.Set<Participant> p)

grantReallocateStateful

public void grantReallocateStateful(java.util.Set<Participant> p)

grantDeallocate

public void grantDeallocate(java.util.Set<Participant> p)

grantDelegate

public void grantDelegate(java.util.Set<Participant> p)

grantSkip

public void grantSkip(java.util.Set<Participant> p)

grantPile

public void grantPile(java.util.Set<Participant> p)

grantSuspendByID

public void grantSuspendByID(java.lang.String userid)

grantReallocateStatelessByID

public void grantReallocateStatelessByID(java.lang.String userid)

grantReallocateStatefulByID

public void grantReallocateStatefulByID(java.lang.String userid)

grantDeallocateByID

public void grantDeallocateByID(java.lang.String userid)

grantDelegateByID

public void grantDelegateByID(java.lang.String userid)

grantSkipByID

public void grantSkipByID(java.lang.String userid)

grantPileByID

public void grantPileByID(java.lang.String userid)

grantSuspendByID

public void grantSuspendByID(java.util.Set userids)

grantReallocateStatelessByID

public void grantReallocateStatelessByID(java.util.Set userids)

grantReallocateStatefulByID

public void grantReallocateStatefulByID(java.util.Set userids)

grantDeallocateByID

public void grantDeallocateByID(java.util.Set userids)

grantDelegateByID

public void grantDelegateByID(java.util.Set userids)

grantSkipByID

public void grantSkipByID(java.util.Set userids)

grantPileByID

public void grantPileByID(java.util.Set userids)

canSuspend

public boolean canSuspend(Participant p)

Convenience boolean methods - return true if the Particpant passed has been granted the privilege

canReallocateStateless

public boolean canReallocateStateless(Participant p)

canReallocateStateful

public boolean canReallocateStateful(Participant p)

canDeallocate

public boolean canDeallocate(Participant p)

canDelegate

public boolean canDelegate(Participant p)

canSkip

public boolean canSkip(Participant p)

canPile

public boolean canPile(Participant p)

hasPrivilege

public boolean hasPrivilege(Participant p,
                            int privilege)

returns true if the Participant has been granted the Privilege

hasParticipants

public boolean hasParticipants(int priv)

returns true if at least one Participant has been granted the Privilege

parse

public void parse(Element e,
                  Namespace nsYawl)

Parses the xml element passed into a set of privileges and who has them

Parameters:

e - the element containing the privileges from the spec xml

toXML

public java.lang.String toXML()

creates xml to describe the entire object

toXML

public java.lang.String toXML(boolean full)