casa.policy

Interface AbstractPolicy

All Superinterfaces:

Cloneable, Comparable<AbstractPolicy>

All Known Implementing Classes:

Policy

public interface AbstractPolicy
extends Cloneable, Comparable<AbstractPolicy>

Method Summary

Modifier and Type	Method and Description
StatusObject<List<Object>>	apply(PolicyAgentInterface agent, Status status, Vector<AbstractPolicy> policyContext, Event event, Map<String,LispObject> map, Object eventInstanceInfo)
AbstractPolicy	clone()
EventDescriptor	getAntecedent()
String	getDoc()
int	getID()
String	getName() Equivalent to getName(false)
String	getName(boolean longVersion) Returns either the long or short form of the name. short form:name long form: name ({performative|*}:{act|*})
String	getSourceFile()
String	getType()
Status	isApplicable(PolicyAgentInterface agent, Event event, Map<String,LispObject> map)
boolean	isGhost() A ghost policy is a policy that shouldn't be counted as being applied.
void	setGhost() Declares this policy a ghost.
void	setSourceFile(String source)
String	toString()
String	toString(int indent)
Object	updateAntecedent(PolicyAgentInterface agent, Map<String,LispObject> map) if there is an unevaluated antecedent, and the evaluation is a EventDescriptor then place this EventDescriptor in the antecedent.

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getName

String getName(boolean longVersion)

Returns either the long or short form of the name.

short form:	name
long form:	name ({performative|*}:{act|*})

Parameters:

longVersion - true indicates to long form is returned

Returns:

Either a long or short form of the name of the policy

getID

int getID()

Returns:

the unique (to this policy set) id number of this policy (automatically generated).

isGhost

boolean isGhost()

A ghost policy is a policy that shouldn't be counted as being applied. For example, the global policy that blindly tries to filfill a social commitment to send that message on receiving or sending that message is a ghost; it doesn't do much (and usually doesn't do anything at all), and would want to consider it the message unhandled if only this policy applied.

Returns:

true if this policy is a ghost.

setGhost

void setGhost()

Declares this policy a ghost. It isn't by default.

See Also:

isGhost()

getName

String getName()

Equivalent to getName(false)

Returns:

the short name of the policy

getType

String getType()

isApplicable

Status isApplicable(PolicyAgentInterface agent,
                    Event event,
                    Map<String,LispObject> map)

updateAntecedent

Object updateAntecedent(PolicyAgentInterface agent,
                        Map<String,LispObject> map)

if there is an unevaluated antecedent, and the evaluation is a EventDescriptor then place this EventDescriptor in the antecedent. The return value is not particularly meaningful, but it can be used to avoid performing the evaluation multiple times as it is guaranteed to be the result of an evaluation of the unevaluated antecedent if there is one.

Parameters:

agent -

map - symbols to be placed in the lisp environment during any evaluation.

Returns:

null if there was no unevaluated antecedent or the object returned from the unevaluated antecedent if there was one.

apply

StatusObject<List<Object>> apply(PolicyAgentInterface agent,
                                 Status status,
                                 Vector<AbstractPolicy> policyContext,
                                 Event event,
                                 Map<String,LispObject> map,
                                 Object eventInstanceInfo)
                          throws Exception,
                                 Throwable

Throws:

Exception

Throwable

toString

String toString()

Overrides:

toString in class Object

toString

String toString(int indent)

getAntecedent

EventDescriptor getAntecedent()

setSourceFile

void setSourceFile(String source)

getSourceFile

String getSourceFile()

getDoc

String getDoc()

Returns:

the documentation string for this object if there is one, otherwise null

clone

AbstractPolicy clone()