org.yawlfoundation.yawl.resourcing.interactions

Class OfferInteraction

java.lang.Object

org.yawlfoundation.yawl.resourcing.interactions.AbstractInteraction

org.yawlfoundation.yawl.resourcing.interactions.OfferInteraction

public class OfferInteraction
extends AbstractInteraction

This class describes the requirements of a task at the offer phase of allocating resources.

Author:

Michael Adams v0.1, 02/08/2007

Field Summary

Fields

Modifier and Type	Field and Description
static int	ROLE_PARAM
static int	USER_PARAM

Fields inherited from class org.yawlfoundation.yawl.resourcing.interactions.AbstractInteraction

_initiator, _ownerTaskID, SYSTEM_INITIATED, USER_INITIATED

Constructor Summary

Constructors

Constructor and Description
OfferInteraction()
OfferInteraction(int initiator)
OfferInteraction(java.lang.String ownerTaskID)

Method Summary

Modifier and Type	Method and Description
void	addConstraint(AbstractConstraint c)
void	addConstraints(java.util.Set constraints)
void	addFilter(AbstractFilter f)
void	addFilters(java.util.Set filters)
boolean	addInputParam(java.lang.String name, int type)
void	addInputParams(java.util.Map pMap)
void	addParticipant(Participant p) variation of the above
void	addParticipant(java.lang.String id) Adds a participant to the initial distribution list
void	addParticipants(java.util.Set pSet)
void	addParticipantsByID(java.util.Set idSet)
void	addParticipantsByID(java.lang.String idList)
void	addParticipantUnchecked(java.lang.String id)
void	addRole(Role r)
void	addRole(java.lang.String rid)
void	addRoles(java.util.Set rSet)
void	addRoles(java.lang.String roleList)
void	addRoleUnchecked(java.lang.String rid)
java.util.Set<AbstractConstraint>	getConstraints()
java.util.Set<Participant>	getDistributionSet()
java.util.Set<java.lang.String>	getDynParamNames()
java.util.Set<AbstractFilter>	getFilters()
java.util.Set<Participant>	getParticipants()
java.util.Set<Role>	getRoles()
void	parse(Element e, Namespace nsYawl)
java.util.Set<Participant>	performOffer(WorkItemRecord wir) Takes the initial distribution set of participants, then expands any roles and/or dynamic parameters to their 'set of participants' equivalents, then applies the specified filters and/or constraints, and returns the final distribution set of participants.
void	setFamiliarParticipantTask(java.lang.String taskid)
java.lang.String	toXML()
void	withdrawOffer(WorkItemRecord wir, java.util.Set<Participant> offeredSet)

Methods inherited from class org.yawlfoundation.yawl.resourcing.interactions.AbstractInteraction

getInitiator, getInitiatorString, getOwnerTaskID, isSystemInitiated, parseInitiator, parseParams, setInitiator, setOwnerTaskID

Methods inherited from class java.lang.Object

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

Field Detail

USER_PARAM

public static final int USER_PARAM

See Also:

Constant Field Values

ROLE_PARAM

public static final int ROLE_PARAM

See Also:

Constant Field Values

Constructor Detail

OfferInteraction

public OfferInteraction()

OfferInteraction

public OfferInteraction(java.lang.String ownerTaskID)

OfferInteraction

public OfferInteraction(int initiator)

Parameters:

initiator - - either AbstractInteraction.SYSTEM_INITIATED or AbstractInteraction.USER_INITIATED

Method Detail

addParticipant

public void addParticipant(java.lang.String id)

Adds a participant to the initial distribution list

Parameters:

id - - the id of the participant

addParticipantUnchecked

public void addParticipantUnchecked(java.lang.String id)

addParticipant

public void addParticipant(Participant p)

variation of the above

Parameters:

p - - the Participant object to add to the initial distribution list

addParticipantsByID

public void addParticipantsByID(java.lang.String idList)

addParticipantsByID

public void addParticipantsByID(java.util.Set idSet)

addParticipants

public void addParticipants(java.util.Set pSet)

addRole

public void addRole(java.lang.String rid)

addRoleUnchecked

public void addRoleUnchecked(java.lang.String rid)

addRole

public void addRole(Role r)

addRoles

public void addRoles(java.lang.String roleList)

addRoles

public void addRoles(java.util.Set rSet)

addInputParam

public boolean addInputParam(java.lang.String name,
                             int type)

addInputParams

public void addInputParams(java.util.Map pMap)

addFilters

public void addFilters(java.util.Set filters)

addFilter

public void addFilter(AbstractFilter f)

addConstraints

public void addConstraints(java.util.Set constraints)

addConstraint

public void addConstraint(AbstractConstraint c)

setFamiliarParticipantTask

public void setFamiliarParticipantTask(java.lang.String taskid)

getParticipants

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

getRoles

public java.util.Set<Role> getRoles()

getFilters

public java.util.Set<AbstractFilter> getFilters()

getConstraints

public java.util.Set<AbstractConstraint> getConstraints()

getDistributionSet

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

getDynParamNames

public java.util.Set<java.lang.String> getDynParamNames()

performOffer

public java.util.Set<Participant> performOffer(WorkItemRecord wir)

Takes the initial distribution set of participants, then expands any roles and/or dynamic parameters to their 'set of participants' equivalents, then applies the specified filters and/or constraints, and returns the final distribution set of participants.

Parameters:

wir - the workitem being offered

Returns:

the final distribution set of Participant objects

withdrawOffer

public void withdrawOffer(WorkItemRecord wir,
                          java.util.Set<Participant> offeredSet)

parse

public void parse(Element e,
                  Namespace nsYawl)
           throws ResourceParseException

Throws:

ResourceParseException

toXML

public java.lang.String toXML()