| org.cougaar.core.plugin.deletion.DeletionPolicy
All known Subclasses: org.cougaar.planning.plugin.deletion.DeletionPolicyBase, org.cougaar.core.plugin.deletion.SimpleDeletionPolicy,
| DeletionPolicy | | public interface DeletionPolicy (Code) | | A policy that controls the timing of the deletion of a blackboard object.
A predicate checks for the applicability of the policy to the object. The
priority disambiguates the case where multiple policies might apply. The
deletionDelay supplies an additional delay before the object is actually
deleted
|
| Field Summary | |
| int | MAX_PRIORITY
The maximum allowable priority for any policy. | | int | MIN_PRIORITY
The minimum allowable priority for any non-default policy. | | long | NO_DELETION_DELAY
A value signifying that the policy has no defined delay. | | int | NO_PRIORITY
A priority guaranteed to be less than any defined priority. |
| Method Summary | |
| long | getDeletionDelay()
Get the additional delay (in scenario time) that should be inserted before
a blackboard object is deleted. | | String | getName()
Get the name of this policy. | | UnaryPredicate | getPredicate()
Get the predicate for this policy. | | int | getPriority()
Get the priority of this policy over other deletion policies. |
| MAX_PRIORITY | | int MAX_PRIORITY(Code) | | The maximum allowable priority for any policy.
|
| MIN_PRIORITY | | int MIN_PRIORITY(Code) | | The minimum allowable priority for any non-default policy.
|
| NO_DELETION_DELAY | | long NO_DELETION_DELAY(Code) | | A value signifying that the policy has no defined delay. If the applicable
policy has such a value, deletion does not occur.
|
| NO_PRIORITY | | int NO_PRIORITY(Code) | | A priority guaranteed to be less than any defined priority. Only the
default policy has NO_PRIORITY. Real policies should have a minimum of
MIN_PRIORITY.
|
| getDeletionDelay | | long getDeletionDelay()(Code) | | Get the additional delay (in scenario time) that should be inserted before
a blackboard object is deleted.
the number of milliseconds of delay before deletion. |
| getName | | String getName()(Code) | | Get the name of this policy. The name is arbitrary and only used in user
interfaces, if any.
the name of the policy. |
| getPredicate | | UnaryPredicate getPredicate()(Code) | | Get the predicate for this policy. The predicate should return true when
applied to objects to which this policy applies.
the predicate selecting objects for which this policy applies. |
| getPriority | | int getPriority()(Code) | | Get the priority of this policy over other deletion policies. When multiple
policies match an object the highest priority policy is used.
the priority of this policy. |
|
|