org.yawlfoundation.yawl.resourcing
Class ResourceMap

java.lang.Object
  extended by org.yawlfoundation.yawl.resourcing.ResourceMap

public class ResourceMap
extends Object

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

Author:
Michael Adams v0.1, 03/08/2007

Constructor Summary
ResourceMap()
           
ResourceMap(String taskID)
           
ResourceMap(YSpecificationID specID, String taskID, org.jdom.Element eleSpec)
           
ResourceMap(YSpecificationID specID, String taskID, org.jdom.Element eleSpec, boolean persisting)
           
 
Method Summary
 void addToOfferedSet(WorkItemRecord wir, Participant p)
           
 WorkItemRecord distribute(WorkItemRecord wir)
           
 boolean equals(Object other)
           
 long get_id()
           
 AllocateInteraction getAllocateInteraction()
           
 Set<Participant> getDistributionSet()
           
 TaggedStringList getIgnoredList(String key)
           
 HashSet<Participant> getOfferedParticipants(String itemID)
           
 OfferInteraction getOfferInteraction()
           
 Participant getPiledResource()
           
 String getPiledResourceID()
           
 SecondaryResources getSecondaryResources()
           
 YSpecificationID getSpecID()
           
 String getSpecName()
           
 StartInteraction getStartInteraction()
           
 String getTaskID()
           
 TaskPrivileges getTaskPrivileges()
           
 int hashCode()
           
 boolean hasPiledResource()
           
 void ignore(WorkItemRecord wir, Participant p)
           
 boolean isPersisting()
           
 void parse(org.jdom.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)
           
 String setPiledResource(Participant p, WorkItemRecord wir)
           
 void setPiledResourceID(String id)
           
 void setSecondaryResources(SecondaryResources sr)
           
 void setSpecID(YSpecificationID specID)
           
 void setStartInteraction(StartInteraction si)
           
 void setTaskID(String taskID)
           
 void setTaskPrivileges(TaskPrivileges tp)
           
 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(String taskID)

ResourceMap

public ResourceMap(YSpecificationID specID,
                   String taskID,
                   org.jdom.Element eleSpec)

ResourceMap

public ResourceMap(YSpecificationID specID,
                   String taskID,
                   org.jdom.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 Set<Participant> getDistributionSet()

getTaskID

public String getTaskID()

setTaskID

public void setTaskID(String taskID)

getSpecName

public String getSpecName()

getSpecID

public YSpecificationID getSpecID()

setSpecID

public void setSpecID(YSpecificationID specID)

getPiledResourceID

public String getPiledResourceID()

setPiledResourceID

public void setPiledResourceID(String id)

getPiledResource

public Participant getPiledResource()

setPiledResource

public 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(String key)

getOfferedParticipants

public HashSet<Participant> getOfferedParticipants(String itemID)

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class 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(org.jdom.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 String toXML()

get_id

public long get_id()

set_id

public void set_id(long id)


Copyright © 2004-2012 The YAWL Foundation.