casa.socialcommitments

Class DependantSocialCommitment

java.lang.Object

java.util.Observable

casa.socialcommitments.SocialCommitment

casa.socialcommitments.DependantSocialCommitment

All Implemented Interfaces:

Describable, Cloneable, Comparable<SocialCommitment>, Observer

public class DependantSocialCommitment
extends SocialCommitment
implements Observer

Title: CASA Agent Infrastructure

Description:

Copyright: Copyright 2003-2014, Knowledge Science Group, University of Calgary. Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. The Knowledge Science Group makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Company: Knowledge Science Group, University of Calgary

A social commitment that is dependent upon another social commitment (the 'guard') to 'fire' (be executed). This is implemented by the observer pattern, where this commitment observes the SCObservable commitment, which will call this commitment's update() method, which will set it's READY status to "true". (SCDependent commitments are initialized with their READY status to false.)

Version:

0.9

Author:

Rob Kremer

Nested Class Summary

Nested classes/interfaces inherited from class casa.socialcommitments.SocialCommitment

SocialCommitment.CommitmentState

Field Summary

Fields

Modifier and Type	Field and Description
private SocialCommitment	guard The agent we're observing
private TriggerEvent	guardEvent
private PerformDescriptor	subjectStatus The status returned by the observed agent, guard

Fields inherited from class casa.socialcommitments.SocialCommitment

DEFAULT_TIMEOUT, MASK_ALL, MASK_EXECUTABLE, MASK_OBLIGATED, MASK_OUTSTANDING

Constructor Summary

Constructors

Constructor and Description
DependantSocialCommitment(PolicyAgentInterface agent, SocialCommitment guard, URLDescriptor newDebtor, URLDescriptor newCreditor, String newPerformative, Act newAct, Event event, Action action)
DependantSocialCommitment(PolicyAgentInterface agent, SocialCommitment guard, URLDescriptor newDebtor, URLDescriptor newCreditor, String newPerformative, Act newAct, Event event, Action action, Event... events)

Method Summary

Modifier and Type	Method and Description
protected StringBuffer	attributesString() Creates a StringBuffer object and fills it with some attributes of this social commitment.
private static Event[]	enbiggen(Event e, Event... events)
protected void	enterTerminalState() Called whenever the SocialCommitment enters a terminal state (FILFILLED, CANCELED, or VIOLATED).
PerformDescriptor	getGuardStatus()
void	setGuard(SocialCommitment newGuard) Sets the guard and sets this commitment's READY state to false (awaiting the guard's execution) if the guard is non-null, READY goes to true otherwise.
void	update(Observable o, Object arg) TODO update this doc Updates the state of this commitment based on the event that has occurred.

Methods inherited from class casa.socialcommitments.SocialCommitment

addObserver, clone, compareTo, designateCanceled, designateFulfilled, designateStarted, equals, execute, flagSet, getAct, getAction, getCreatedTime, getCreditor, getDebtor, getEndTime, getEvent, getEventOfType, getFlags, getMessage, getOwnerConversationID, getParameter, getPerformative, getPriority, getSerialNumber, getState, hasEventOfType, hashCode, keySet, meetsMask, notifyObservers, retractTimeoutEvent, setDebtor, setMarked, setNotDebtor, setParameter, setPersistent, setPriority, setShared, toString, toString

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers, setChanged

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

guard

private SocialCommitment guard

The agent we're observing

subjectStatus

private PerformDescriptor subjectStatus

The status returned by the observed agent, guard

guardEvent

private TriggerEvent guardEvent

Constructor Detail

DependantSocialCommitment

public DependantSocialCommitment(PolicyAgentInterface agent,
                                 SocialCommitment guard,
                                 URLDescriptor newDebtor,
                                 URLDescriptor newCreditor,
                                 String newPerformative,
                                 Act newAct,
                                 Event event,
                                 Action action)

Parameters:

guard -

newDebtor -

newCreditor -

newPerformative -

newAct -

msg -

action -

DependantSocialCommitment

public DependantSocialCommitment(PolicyAgentInterface agent,
                                 SocialCommitment guard,
                                 URLDescriptor newDebtor,
                                 URLDescriptor newCreditor,
                                 String newPerformative,
                                 Act newAct,
                                 Event event,
                                 Action action,
                                 Event... events)

Method Detail

enbiggen

private static Event[] enbiggen(Event e,
                                Event... events)

update

public void update(Observable o,
                   Object arg)

Description copied from class: SocialCommitment

TODO update this doc Updates the state of this commitment based on the event that has occurred. See the class documentation for a description of the state machine and its transitions.

Specified by:

update in interface Observer

Overrides:

update in class SocialCommitment

See Also:

EventObserver.notifyEventOccurred(java.lang.String, casa.event.Event, java.lang.Object)

attributesString

protected StringBuffer attributesString()

Description copied from class: SocialCommitment

Creates a StringBuffer object and fills it with some attributes of this social commitment. This method should be overridden in subclasses to give more information.

Overrides:

attributesString in class SocialCommitment

Returns:

A string buffer filled with descriptions of some attributes of this social commitment.

getGuardStatus

public PerformDescriptor getGuardStatus()

Returns:

the value of the execution of the Action of the guard commitment, or null if the guard commitment's Action has not been executed.

setGuard

public void setGuard(SocialCommitment newGuard)

Sets the guard and sets this commitment's READY state to false (awaiting the guard's execution) if the guard is non-null, READY goes to true otherwise.

Parameters:

newGuard - The guard

enterTerminalState

protected void enterTerminalState()

Called whenever the SocialCommitment enters a terminal state (FILFILLED, CANCELED, or VIOLATED). Subclasses should override this method to clean up as appropriate.

Overrides:

enterTerminalState in class SocialCommitment