org.yawlfoundation.yawl.resourcing

Class ResourceMap

java.lang.Object

org.yawlfoundation.yawl.resourcing.ResourceMap

public class ResourceMap
extends java.lang.Object

Manages all of the resourcing requirements and distribution strategies for one task.

Author:

Michael Adams v0.1, 03/08/2007

Constructor Summary

Constructors

Constructor and Description
ResourceMap()
ResourceMap(java.lang.String taskID)
ResourceMap(YSpecificationID specID, java.lang.String taskID, Element eleSpec)
ResourceMap(YSpecificationID specID, java.lang.String taskID, Element eleSpec, boolean persisting)

Method Summary

Modifier and Type	Method and Description
void	addToOfferedSet(WorkItemRecord wir, Participant p)
WorkItemRecord	distribute(WorkItemRecord wir)
boolean	equals(java.lang.Object other)
long	get_id()
AllocateInteraction	getAllocateInteraction()
java.util.Set<Participant>	getDistributionSet()
TaggedStringList	getIgnoredList(java.lang.String key)
java.util.Set<Participant>	getOfferedParticipants(java.lang.String itemID)
OfferInteraction	getOfferInteraction()
Participant	getPiledResource()
java.lang.String	getPiledResourceID()
SecondaryResources	getSecondaryResources()
YSpecificationID	getSpecID()
java.lang.String	getSpecName()
StartInteraction	getStartInteraction()
java.lang.String	getTaskID()
TaskPrivileges	getTaskPrivileges()
int	hashCode()
boolean	hasOffers(java.lang.String itemID)
boolean	hasPiledResource()
void	ignore(WorkItemRecord wir, Participant p)
boolean	isPersisting()
void	parse(Element eleSpec) Parse the Element passed for task resourcing info and build the appropriate objects.
void	removeIgnoreList(WorkItemRecord wir)
void	removePiledResource()
void	set_id(long id)
void	setAllocateInteraction(AllocateInteraction ai)
void	setOfferInteraction(OfferInteraction oi)
void	setPersisting(boolean persist)
java.lang.String	setPiledResource(Participant p, WorkItemRecord wir)
void	setPiledResourceID(java.lang.String id)
void	setSecondaryResources(SecondaryResources sr)
void	setSpecID(YSpecificationID specID)
void	setStartInteraction(StartInteraction si)
void	setTaskID(java.lang.String taskID)
void	setTaskPrivileges(TaskPrivileges tp)
java.lang.String	toXML()
void	withdrawOffer(WorkItemRecord wir) removes the workitem from all offer queues

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceMap

public ResourceMap()

ResourceMap

public ResourceMap(java.lang.String taskID)

ResourceMap

public ResourceMap(YSpecificationID specID,
                   java.lang.String taskID,
                   Element eleSpec)

ResourceMap

public ResourceMap(YSpecificationID specID,
                   java.lang.String taskID,
                   Element eleSpec,
                   boolean persisting)

Method Detail

setOfferInteraction

public void setOfferInteraction(OfferInteraction oi)

setAllocateInteraction

public void setAllocateInteraction(AllocateInteraction ai)

setStartInteraction

public void setStartInteraction(StartInteraction si)

setSecondaryResources

public void setSecondaryResources(SecondaryResources sr)

setTaskPrivileges

public void setTaskPrivileges(TaskPrivileges tp)

getOfferInteraction

public OfferInteraction getOfferInteraction()

getAllocateInteraction

public AllocateInteraction getAllocateInteraction()

getStartInteraction

public StartInteraction getStartInteraction()

getSecondaryResources

public SecondaryResources getSecondaryResources()

getTaskPrivileges

public TaskPrivileges getTaskPrivileges()

getDistributionSet

public java.util.Set<Participant> getDistributionSet()

getTaskID

public java.lang.String getTaskID()

setTaskID

public void setTaskID(java.lang.String taskID)

getSpecName

public java.lang.String getSpecName()

getSpecID

public YSpecificationID getSpecID()

setSpecID

public void setSpecID(YSpecificationID specID)

getPiledResourceID

public java.lang.String getPiledResourceID()

setPiledResourceID

public void setPiledResourceID(java.lang.String id)

getPiledResource

public Participant getPiledResource()

setPiledResource

public java.lang.String setPiledResource(Participant p,
                                         WorkItemRecord wir)

removePiledResource

public void removePiledResource()

hasPiledResource

public boolean hasPiledResource()

setPersisting

public void setPersisting(boolean persist)

isPersisting

public boolean isPersisting()

ignore

public void ignore(WorkItemRecord wir,
                   Participant p)

getIgnoredList

public TaggedStringList getIgnoredList(java.lang.String key)

getOfferedParticipants

public java.util.Set<Participant> getOfferedParticipants(java.lang.String itemID)

hasOffers

public boolean hasOffers(java.lang.String itemID)

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

distribute

public WorkItemRecord distribute(WorkItemRecord wir)

withdrawOffer

public void withdrawOffer(WorkItemRecord wir)

removes the workitem from all offer queues

removeIgnoreList

public void removeIgnoreList(WorkItemRecord wir)

addToOfferedSet

public void addToOfferedSet(WorkItemRecord wir,
                            Participant p)

parse

public void parse(Element eleSpec)

Parse the Element passed for task resourcing info and build the appropriate objects.

Parameters:

eleSpec - the [resourcing] section from a particular task definition within a specification file.

toXML

public java.lang.String toXML()

get_id

public long get_id()

set_id

public void set_id(long id)