SocialCommitment

java.lang.Object
- java.util.Observable
- - casa.socialcommitments.SocialCommitment

All Implemented Interfaces:

Describable, Cloneable, Comparable<SocialCommitment>, Observer

Direct Known Subclasses:

DependantSocialCommitment
```
public class SocialCommitment
extends Observable
implements Observer, Comparable<SocialCommitment>, Describable
```
SocialCommitment is a class to track a social commitment. The following chart shows the possible states and their transitions.

The state machine follows the following rules:
- The state machine starts in the created state.
- The state machine ends in one of the fulfilled, canceled, or violated states.
- If the start event occurs and the current state is created, then the current state is set to started.
- If the perform action event occurs and the current state is started, then the current state is set to perform-action.
- If the state becomes started, and the perform action event has previously occurred, then the current state is set to perform-action.
- If the stop event occurs and the current state is started or perform-action, then the current state is set to fulfilled.
- If the state becomes started, and the stop event has previously occurred, then the current state is set to fulfilled .
- If execute(PolicyAgentInterface) is called and the current state is perform-action, then the current state is set to ready-fulfilled .
- If designateFulfilled() is called and the current state is not an end state, then the current state is set to fulfilled.
- If designateCanceled() is called and the current state is not an end state, then the current state is set to canceled.
- If designateStarted() is called and the current state is not an end state, then the current state is set to started.
- If the violation event occurs and the current state is not an end state, then the current state is set to violated.
- If the social commitment does not have a start event or perform action event, then those events are considered to have occurred.
- If the start event or the perform action event occur before they have an effect, then the fact that they have occurred is recorded.
- If the social commitment does not have a stop event or a violation event, then those event never occur.
Version:

0.9

Author:

Jason Heard, Rob Kremer

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SocialCommitment.CommitmentState` The `CommitmentState` enumeration is used to describe the set of possible states that a social commitment may be in.

Field Summary

Fields
Modifier and Type	Field and Description
`private Act`	`act` The act of this commitment.
`private Action`	`action` The action that should fulfil this commitment.
`private PolicyAgentInterface`	`agent` The agent that "owns" this SocialCommitment.
`private long`	`createdTime` The time that this social commitment was created.
`private URLDescriptor`	`creditor` The creditor of this commitment.
`private SocialCommitment.CommitmentState`	`currentState` The current state of the commitment.
`private URLDescriptor`	`debtor` The debtor of this commitment.
`(package private) static long`	`DEFAULT_TIMEOUT` The time from current that the SocialCommitment will go Violated if not otherwise specified.
`private long`	`endTime` The time when this commitment ended (was fulfilled, canceled or violated).
`private Event`	`event` The event that caused the creation of this social commitment.
`private Map<String,Event>`	`events` A map which contains the events associated with this commitment.
`static Set<SocialCommitmentStatusFlags>`	`MASK_ALL` An empty set of status flags.
`static Set<SocialCommitmentStatusFlags>`	`MASK_EXECUTABLE` The set of status flags that, if set, indicate that a social commitment is executable.
`static Set<SocialCommitmentStatusFlags>`	`MASK_OBLIGATED` The set of status flags that, if set, indicate that a social commitment represents an obligation for the debtor of that social commitment.
`static Set<SocialCommitmentStatusFlags>`	`MASK_OUTSTANDING` The set of status flags that, if set, indicate that a social commitment is outstanding.
`private static long`	`nextSerialNumber` This is the next serial number to be used.
`private String`	`ownerConversationID` The ID of the Conversation in which the Social Commitment was formed
`private TreeMap<String,String>`	`params` Supports the `Describable` interface
`private boolean`	`performActionEventOccurred` Used to indicate that the perform action event has occurred, but had no effect because it fired before the start event.
`private String`	`performative` The performative of this commitment.
`private int`	`priority` The priority of this commitment.
`private long`	`serialNumber` This is a unique serial number for each social commitment.
`private static CasaLispOperator`	`SOCIALCOMMITMENT`
`private static Set<SocialCommitmentStatusFlags>`	`STATIC_STATUS_FLAGS` The set of status flags which do not change when the state of a social commitment changes.
`private EnumSet<SocialCommitmentStatusFlags>`	`statusFlags` A set of status flags for this social commitment.
`private boolean`	`stopEventOccurred` Used to indicate that the stop event has occurred, but had no effect because it fired before the agent

Constructor Summary

Constructors
Constructor and Description
`SocialCommitment(PolicyAgentInterface agent, URLDescriptor newDebtor, URLDescriptor newCreditor, String newPerformative, Act newAct, Event event, Action newAction)` Constructs a new social commitment from the given information.
`SocialCommitment(PolicyAgentInterface agent, URLDescriptor newDebtor, URLDescriptor newCreditor, String newPerformative, Act newAct, Event event, Action newAction, Event... newEvents)` Constructs a new social commitment from the given information.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addObserver(SocialCommitment sco)` TODO Document the addObserver method.
`protected StringBuffer`	`attributesString()` Creates a `StringBuffer` object and fills it with some attributes of this social commitment.
`SocialCommitment`	`clone()`
`int`	`compareTo(SocialCommitment commitment)` Compare the given social commitment to this social commitment.
`boolean`	`designateCanceled()` Attempts to change the state of this commitment to `canceled`.
`boolean`	`designateFulfilled()` Attempts to change the state of this commitment to `fulfilled`.
`boolean`	`designateStarted()` Attempts to reset the social commitment by changing the state of this commitment to `started`.
`protected void`	`enterTerminalState()` Called whenever the SocialCommitment enters a terminal state (FILFILLED, CANCELED, or VIOLATED).
`boolean`	`equals(Object object)` Determines if the given object is equal to this social commitment.
`private boolean`	`equals(SocialCommitment commitment)` Determines if the given social commitment is equal to this social commitment.
`PerformDescriptor`	`execute(PolicyAgentInterface agent)` Executes this social commitment by performing its associated action.
`boolean`	`flagSet(SocialCommitmentStatusFlags flagToCheck)` Determines if this social commitment has the given status flag set to `true`.
`Act`	`getAct()` Retrieves the act of this commitment.
`Action`	`getAction()` Retrieves the action of this commitment.
`long`	`getCreatedTime()` Retrieves the time that this social commitment was created.
`URLDescriptor`	`getCreditor()` Retrieves the creditor of this commitment.
`URLDescriptor`	`getDebtor()` Retrieves the debtor of this commitment.
`long`	`getEndTime()` Returns the time this commitment ended (was fulfilled, canceled or expired).
`Event`	`getEvent()` Retrieves the Event that caused the creation of this social commitment.
`protected Event`	`getEventOfType(String type)` Retrieves the event of the indicated type, if any.
`Set<SocialCommitmentStatusFlags>`	`getFlags()` Retrieves this social commitment's set of status flags.
`MLMessage`	`getMessage()` Retrieves the message in the event that caused the creation of this social commitment, if there is one; else null.
`String`	`getOwnerConversationID()`
`String`	`getParameter(String key)` Retrieves a parameter of this object.
`String`	`getPerformative()` Retrieves the performative of this commitment.
`int`	`getPriority()` Retrieves the priority of this commitment.
`long`	`getSerialNumber()` Retrieves the unique serial number for this social commitment.
`SocialCommitment.CommitmentState`	`getState()`
`protected boolean`	`hasEventOfType(String type)` Determines if this social commitment has an event of the indicated type.
`int`	`hashCode()` Returns a hashing of this social commitment.
`Set<String>`	`keySet()`
`boolean`	`meetsMask(Set<SocialCommitmentStatusFlags> mask)` Determines if this social commitment has all of the status flags given in the mask set to `true`.
`(package private) void`	`notifyObservers(PerformDescriptor stat)` TODO Document the notifyObservers method.
`protected void`	`retractTimeoutEvent()`
`void`	`setDebtor(boolean isDebtor)` Sets the `DEBTOR` flag to be the same as the given value.
`void`	`setMarked(boolean marked)` Sets the `MARKED` flag to be the same as the given value.
`void`	`setNotDebtor(boolean isNotDebtor)` Sets the `NOTDEBTOR` flag to be the same as the given value.
`void`	`setParameter(String parameter, String value)` Sets a parameter in the object.
`void`	`setPersistent(boolean isPersistent)` Sets the `PERSISTENT` flag to be the same as the given value.
`void`	`setPriority(int newPriority)` Sets the priority of this commitment.
`void`	`setShared(boolean isShared)` Sets the `SHARED` flag to be the same as the given value.
`String`	`toString()` Returns a string describing this social commitment.
`String`	`toString(boolean prettyPrint)` Returns a string describing this social commitment.
`void`	`update(Observable o, Object arg)` TODO update this doc Updates the state of this commitment based on the event that has occurred.
`private void`	`updateStateAtStartup()` Moves forward in the state machine from the state of `created` when the commitment is first created.
`private void`	`updateStatePerformingAction()` Moves forward in the state machine from the state of `perform-action` when the commitment is executed.
`private void`	`updateStatusWord()` Updates the `status flags` based on the current state of the social commitment.

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
  - agent
```
private PolicyAgentInterface agent
```
    The agent that "owns" this SocialCommitment. Used primarily for reporting back state changes.
  - debtor
```
private URLDescriptor debtor
```
    The debtor of this commitment. This is the agent who owes the debtor to perform the action of this commitment.
  - creditor
```
private URLDescriptor creditor
```
    The creditor of this commitment. This is the agent who is owed the action of this commitment.
  - performative
```
private String performative
```
    The performative of this commitment. This represents the type of action that this commitment requires the debtor to perform.
  - act
```
private Act act
```
    The act of this commitment. This is typically the same as the act of the message that caused the creation of this commitment.
  - event
```
private Event event
```
    The event that caused the creation of this social commitment.
  - action
```
private Action action
```
    The action that should fulfil this commitment.
  - params
```
private TreeMap<String,String> params
```
    Supports the Describable interface
  - createdTime
```
private final long createdTime
```
    The time that this social commitment was created. It is stored in the format given by System.currentTimeMillis(). It cannot change over the lifetime of a social commitment.
  - endTime
```
private long endTime
```
    The time when this commitment ended (was fulfilled, canceled or violated). It is stored in the format given by System.currentTimeMillis(). A value of 0 indicates that this social commitment has not ended.
  - events
```
private Map<String,Event> events
```
    A map which contains the events associated with this commitment. The keys in the map indicate the type of event, and the values are the events themselves. The event types are strings, which are part of the CASAOntology. The event type can be one of:
  - priority
```
private int priority
```
    The priority of this commitment. Lower numbers are less urgent, and the default priority is 10.
  - serialNumber
```
private final long serialNumber
```
    This is a unique serial number for each social commitment. It does not affect equals, because then it would be impossible to create two commitments that are equal to one another.
  - nextSerialNumber
```
private static long nextSerialNumber
```
    This is the next serial number to be used.
  - currentState
```
private SocialCommitment.CommitmentState currentState
```
    The current state of the commitment. See the class description for a description of the states and the transitions between them.
  - statusFlags
```
private EnumSet<SocialCommitmentStatusFlags> statusFlags
```
    A set of status flags for this social commitment. The set contains a subset of the SocialCommitmentStatusFlags enumeration. For each flag, if it is contained within this set, it is considered to be set to true. If it is not in this set, it is considered to be false.
  - ownerConversationID
```
private String ownerConversationID
```
    The ID of the Conversation in which the Social Commitment was formed
  - DEFAULT_TIMEOUT
```
static final long DEFAULT_TIMEOUT
```
    The time from current that the SocialCommitment will go Violated if not otherwise specified.
    
    See Also:
    
    Constant Field Values
  - performActionEventOccurred
```
private boolean performActionEventOccurred
```
    Used to indicate that the perform action event has occurred, but had no effect because it fired before the start event.
  - stopEventOccurred
```
private boolean stopEventOccurred
```
    Used to indicate that the stop event has occurred, but had no effect because it fired before the agent
  - MASK_ALL
```
public static final Set<SocialCommitmentStatusFlags> MASK_ALL
```
    An empty set of status flags. If this mask is passed into meetsMask(Set), it will always return true.
  - MASK_EXECUTABLE
```
public static final Set<SocialCommitmentStatusFlags> MASK_EXECUTABLE
```
    The set of status flags that, if set, indicate that a social commitment is executable.
  - MASK_OUTSTANDING
```
public static final Set<SocialCommitmentStatusFlags> MASK_OUTSTANDING
```
    The set of status flags that, if set, indicate that a social commitment is outstanding.
  - MASK_OBLIGATED
```
public static final Set<SocialCommitmentStatusFlags> MASK_OBLIGATED
```
    The set of status flags that, if set, indicate that a social commitment represents an obligation for the debtor of that social commitment.
  - STATIC_STATUS_FLAGS
```
private static Set<SocialCommitmentStatusFlags> STATIC_STATUS_FLAGS
```
    The set of status flags which do not change when the state of a social commitment changes. This set includes:
  - SOCIALCOMMITMENT
```
private static final CasaLispOperator SOCIALCOMMITMENT
```
- Constructor Detail
  - SocialCommitment
```
public SocialCommitment(PolicyAgentInterface agent,
                        URLDescriptor newDebtor,
                        URLDescriptor newCreditor,
                        String newPerformative,
                        Act newAct,
                        Event event,
                        Action newAction,
                        Event... newEvents)
```
    Constructs a new social commitment from the given information. The new social commitment is set up by performing the following operations:
    1. The parameters which are given are saved in the appropriate fields.
    2. The creation time is set to System.currentTimeMillis().
    3. The priority is set to the priority parameter of the given message if it exists. If it does not exist, it is set to the default value of 10.
    4. The serial number is set to the next serial number, which is incremented.
    5. Several static status flags are set based on the given information or their default values.
    6. The given action and events are notified of their new master.
    7. The state is set to created and then updateStateAtStartup() is called.
    8. All of the events are started.
    Parameters:
    
    newDebtor - The debtor of the new social commitment.
    
    newCreditor - The creditor of the new social commitment.
    
    newPerformative - The performative of the new social commitment.
    
    newAct - The act of the new social commitment.
    
    msg - The message which caused the creation of the new social commitment.
    
    newAction - The action which should fulfill the new social commitment.
    
    newEvents - The set of events associated with the new social commitment.
  - SocialCommitment
```
public SocialCommitment(PolicyAgentInterface agent,
                        URLDescriptor newDebtor,
                        URLDescriptor newCreditor,
                        String newPerformative,
                        Act newAct,
                        Event event,
                        Action newAction)
```
    Constructs a new social commitment from the given information. This is a convenience constructor for when no events are given for the new social commitment. This constructor calls #SocialCommitment(URLDescriptor, URLDescriptor, String, Act, MLMessage, Action, Event...) with a null final argument.
    
    Parameters:
    
    agent -
    
    newDebtor - The debtor of the new social commitment.
    
    newCreditor - The creditor of the new social commitment.
    
    newPerformative - The performative of the new social commitment.
    
    newAct - The act of the new social commitment.
    
    msg - The message which caused the creation of the new social commitment.
    
    newAction - The action which should fulfill the new social commitment.
- Method Detail
  - getOwnerConversationID
```
public String getOwnerConversationID()
```
  - getDebtor
```
public URLDescriptor getDebtor()
```
    Retrieves the debtor of this commitment. This is the agent who owes the debtor to perform the action of this commitment.
    
    Returns:
    
    The debtor of this commitment.
  - getCreditor
```
public URLDescriptor getCreditor()
```
    Retrieves the creditor of this commitment. This is the agent who is owed the action of this commitment.
    
    Returns:
    
    The creditor of this commitment.
  - getPerformative
```
public String getPerformative()
```
    Retrieves the performative of this commitment. This represents the type of action that this commitment requires the debtor to perform.
    
    Returns:
    
    the performative of this commitment.
  - getAct
```
public Act getAct()
```
    Retrieves the act of this commitment. This is typically the same as the act of the message that caused the creation of this commitment.
    
    Returns:
    
    The act of this commitment.
  - getAction
```
public Action getAction()
```
    Retrieves the action of this commitment.
    
    Returns:
    
    The action of this commitment.
  - getEvent
```
public Event getEvent()
```
    Retrieves the Event that caused the creation of this social commitment.
    
    Returns:
    
    The Event that caused the creation of this social commitment.
  - getMessage
```
public MLMessage getMessage()
```
    Retrieves the message in the event that caused the creation of this social commitment, if there is one; else null.
    
    Returns:
    
    The message in the event that caused the creation of this social commitment.
  - getCreatedTime
```
public long getCreatedTime()
```
    Retrieves the time that this social commitment was created. It is stored in the format given by System.currentTimeMillis() . It cannot change over the lifetime of a social commitment.
    
    Returns:
    
    The time that this social commitment was created.
  - getEndTime
```
public long getEndTime()
```
    Returns the time this commitment ended (was fulfilled, canceled or expired). It is stored in the format given by System.currentTimeMillis() . MAX_VALUE if it has not ended.
    
    Returns:
    
    The time this commitment was fulfilled, canceled or expired, or Long.MAX_VALUE if it has not ended.
  - getState
```
public SocialCommitment.CommitmentState getState()
```
    Returns:
    
    The current state of this SocialCommitment
    
    See Also:
    
    SocialCommitment.CommitmentState
  - getPriority
```
public int getPriority()
```
    Retrieves the priority of this commitment. Lower numbers are less urgent, and the default priority is 10.
    
    Returns:
    
    The priority of this commitment.
  - setPriority
```
public void setPriority(int newPriority)
```
    Sets the priority of this commitment. Lower numbers are less urgent, and the default priority is 10.
    
    Parameters:
    
    newPriority - The new value of priority.
  - getSerialNumber
```
public long getSerialNumber()
```
    Retrieves the unique serial number for this social commitment. It does not affect equals, because then it would be impossible to create two commitments that are equal to one another.
    
    Returns:
    
    The unique serial number for this social commitment.
  - hasEventOfType
```
protected boolean hasEventOfType(String type)
```
    Determines if this social commitment has an event of the indicated type.
    
    Parameters:
    
    type - A string describing the type of event that the calling method is curious about.
    
    Returns:
    
    true if this commitment has an event of the specified type; false otherwise.
  - getEventOfType
```
protected Event getEventOfType(String type)
```
    Retrieves the event of the indicated type, if any.
    
    Parameters:
    
    type - A string describing the type of event that should be retrieved.
    
    Returns:
    
    An event of the type specified, or null if this commitment does not have an event of the specified type.
  - execute
```
public PerformDescriptor execute(PolicyAgentInterface agent)
```
    Executes this social commitment by performing its associated action. This is done in several steps:
    1. updateStatePerformingAction() is called to move the state machine forward.
    2. action.perform(PolicyAgentInterface) is called to actually perform the action associated with this social commitment. If there is no associated action, a perform descriptor with a status of 0 is returned.
    3. If the status of the perform descriptor returned by the execution of the action has a status of TransientAgent.DEFER_ACTION, then the social commitment is restarted by calling designateStarted().
    4. If the status of the perform descriptor returned by the execution of the action has a status of TransientAgent.DROP_ACTION, then the social commitment is fulfilled by calling designateFulfilled().
    5. If the status of the perform descriptor returned by the execution of the action does not have a status of TransientAgent.DEFER_ACTION or TransientAgent.DROP_ACTION, then all observers are notified by calling notifyObservers(PerformDescriptor) with the status that will be returned by this method.
    6. If the SHARED flag is not set to true, then the social commitment is fulfilled by calling designateFulfilled().
    7. Finally, the perform descriptor returned by the execution of the action is returned.
    Parameters:
    
    agent - The agent in which will provide the context for the execution of this social commitment.
    
    Returns:
    
    The status returned by action.perform(PolicyAgentInterface) if it is not null.
  - updateStateAtStartup
```
private void updateStateAtStartup()
```
    Moves forward in the state machine from the state of created when the commitment is first created. This happens if no event of type start is found, and continues if no event of type perform action are found.
  - updateStatePerformingAction
```
private void updateStatePerformingAction()
```
    Moves forward in the state machine from the state of perform-action when the commitment is executed. This is called from execute(PolicyAgentInterface).
  - designateStarted
```
public boolean designateStarted()
```
    Attempts to reset the social commitment by changing the state of this commitment to started. This will only occur if the commitment has not already ended (been fulfilled, canceled or violated).
    
    Returns:
    
    true if this commitment has been successfully restarted (had its state set to started); false otherwise.
  - designateFulfilled
```
public boolean designateFulfilled()
```
    Attempts to change the state of this commitment to fulfilled. This will only occur if the commitment has not already ended (been fulfilled, canceled or violated). This also has the effect of setting the endTime to System.currentTimeMillis().
    
    Returns:
    
    true if the state of this commitment has been successfully set to fulfilled; false otherwise.
  - retractTimeoutEvent
```
protected void retractTimeoutEvent()
```
  - designateCanceled
```
public boolean designateCanceled()
```
    Attempts to change the state of this commitment to canceled. This will only occur if the commitment has not already ended (been fulfilled, canceled or violated). If successful, this also has the effect of setting the endTime to System.currentTimeMillis().
    
    Returns:
    
    true if the state of this commitment has been successfully set to canceled; false otherwise.
  - equals
```
public boolean equals(Object object)
```
    Determines if the given object is equal to this social commitment. This is true if the given object is this social commitment, or if the given object is a social commitment and the equals(SocialCommitment) method returns true for that commitment. Otherwise, the object is not considered to be equal to this object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    object - The object to compare to this for equality.
    
    Returns:
    
    true if the given object is equal to this social commitment; false otherwise.
  - equals
```
private boolean equals(SocialCommitment commitment)
```
    Determines if the given social commitment is equal to this social commitment. The commitments are considered equal if each of the following fields in both social commitents are equal:
    Parameters:
    
    commitment - The commitment to compare to this for equality.
    
    Returns:
    
    true if the given social commitment is equal to this social commitment; false otherwise.
  - compareTo
```
public int compareTo(SocialCommitment commitment)
```
    Compare the given social commitment to this social commitment. This is done by comparing identical fields in both social commitments. The fields are compared in the following order. The first instance of inequality is returned.
    Specified by:
    
    compareTo in interface Comparable<SocialCommitment>
    
    Parameters:
    
    commitment - The commitment to compare to this for equality.
    
    Returns:
    
    The value 0 if the two social commitments are equal; a value less than 0 if this commitment comes before the given commitment; and a value greater than 0 if the given commitment comes before this commitment.
  - hashCode
```
public int hashCode()
```
    Returns a hashing of this social commitment. The hash code is based on the following fields:
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    A hashing code of this social commitment.
  - toString
```
public String toString()
```
    Returns a string describing this social commitment. This string is not complete enough to recreate the social commitment, but is instead intended to be displayed in an interface. The string contains simplified versions of the following fields:
    In addition, it incorporates the string produced by attributesString().
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string describing this social commitment.
  - toString
```
public String toString(boolean prettyPrint)
```
    Returns a string describing this social commitment. This string is not complete enough to recreate the social commitment, but is instead intended to be displayed in an interface. The string contains simplified versions of the following fields:
    In addition, it incorporates the string produced by attributesString().
    Parameters:
    
    prettyPrint - Return a more human-readable string.
    
    Returns:
    
    A string describing this social commitment.
  - attributesString
```
protected StringBuffer attributesString()
```
    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.
    
    Returns:
    
    A string buffer filled with descriptions of some attributes of this social commitment.
  - update
```
public void update(Observable o,
                   Object arg)
```
    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
    
    Parameters:
    
    type - A string representing the type of event that has occurred.
    
    event - The event that fired.
    
    instanceInfo - An object that details the event occurrence.
    
    See Also:
    
    EventObserver.notifyEventOccurred(java.lang.String, casa.event.Event, java.lang.Object)
  - setDebtor
```
public void setDebtor(boolean isDebtor)
```
    Sets the DEBTOR flag to be the same as the given value.
    
    Parameters:
    
    isDebtor - The new value for the DEBTOR flag.
  - setNotDebtor
```
public void setNotDebtor(boolean isNotDebtor)
```
    Sets the NOTDEBTOR flag to be the same as the given value.
    
    Parameters:
    
    isDebtor - The new value for the NOTDEBTOR flag.
  - setShared
```
public void setShared(boolean isShared)
```
    Sets the SHARED flag to be the same as the given value.
    
    Parameters:
    
    isDebtor - The new value for the SHARED flag.
  - setPersistent
```
public void setPersistent(boolean isPersistent)
```
    Sets the PERSISTENT flag to be the same as the given value.
    
    Parameters:
    
    isDebtor - The new value for the PERSISTENT flag.
  - setMarked
```
public void setMarked(boolean marked)
```
    Sets the MARKED flag to be the same as the given value.
    
    Parameters:
    
    isDebtor - The new value for the MARKED flag.
  - getFlags
```
public Set<SocialCommitmentStatusFlags> getFlags()
```
    Retrieves this social commitment's set of status flags.
    
    Returns:
    
    This social commitment's set of status flags.
  - flagSet
```
public boolean flagSet(SocialCommitmentStatusFlags flagToCheck)
```
    Determines if this social commitment has the given status flag set to true.
    
    Parameters:
    
    flagToCheck - The status flag which is to be checked in this social commitment.
    
    Returns:
    
    true if this social commitment has the given status flag set to true; false otherwise.
  - meetsMask
```
public boolean meetsMask(Set<SocialCommitmentStatusFlags> mask)
```
    Determines if this social commitment has all of the status flags given in the mask set to true.
    
    Parameters:
    
    mask - The set of status flags which are to be checked in this social commitment.
    
    Returns:
    
    true if this social commitment has all of the status flags given in the mask set to true; false otherwise.
  - updateStatusWord
```
private void updateStatusWord()
```
    Updates the status flags based on the current state of the social commitment. This is done by copying the current status flags, retaining only the status flags in STATIC_STATUS_FLAGS, and then setting all of the remaining flags conditionally based on the current state of the commitment.
  - 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.
  - addObserver
```
protected void addObserver(SocialCommitment sco)
```
    TODO Document the addObserver method.
    
    Parameters:
    
    sco -
  - notifyObservers
```
void notifyObservers(PerformDescriptor stat)
```
    TODO Document the notifyObservers method.
    
    Parameters:
    
    stat -
  - getParameter
```
public String getParameter(String key)
```
    Description copied from interface: Describable
    
    Retrieves a parameter of this object. If the parameter is not found, returns null.
    
    Specified by:
    
    getParameter in interface Describable
    
    Parameters:
    
    key - String indication which parameter to retrieve.
  - keySet
```
public Set<String> keySet()
```
    Specified by:
    
    keySet in interface Describable
    
    Returns:
    
    the set of all the keys for this object
  - setParameter
```
public void setParameter(String parameter,
                         String value)
```
    Description copied from interface: Describable
    
    Sets a parameter in the object. If the parameter has not been defined then there is a fault in the document - likely it was not parsed prior to calling setParameter, so the document was not instantiated. If the parameter has been previously defined it is updated to reflect the value specified.
    
    Specified by:
    
    setParameter in interface Describable
    
    Parameters:
    
    parameter - name of the parameter to set/add
    
    value - string value to associate with the parameter
  - clone
```
public SocialCommitment clone()
```
    Specified by:
    
    clone in interface Describable
    
    Overrides:
    
    clone in class Object

Class SocialCommitment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Field Detail

agent

debtor

creditor

performative

act

event

action

params

createdTime

endTime

events

priority

serialNumber

nextSerialNumber

currentState

statusFlags

ownerConversationID

DEFAULT_TIMEOUT

performActionEventOccurred

stopEventOccurred

MASK_ALL

MASK_EXECUTABLE

MASK_OUTSTANDING

MASK_OBLIGATED

STATIC_STATUS_FLAGS

SOCIALCOMMITMENT

Constructor Detail

SocialCommitment

SocialCommitment

Method Detail

getOwnerConversationID

getDebtor

getCreditor

getPerformative

getAct

getAction

getEvent

getMessage

getCreatedTime

getEndTime

getState

getPriority

setPriority

getSerialNumber

hasEventOfType

getEventOfType

execute

updateStateAtStartup

updateStatePerformingAction

designateStarted

designateFulfilled

retractTimeoutEvent

designateCanceled

equals

equals

compareTo

hashCode

toString

toString

attributesString

update

setDebtor

setNotDebtor

setShared

setPersistent

setMarked

getFlags

flagSet

meetsMask

updateStatusWord

enterTerminalState

addObserver