| org.cougaar.planning.ldm.plan.NewTask
All known Subclasses: org.cougaar.planning.ldm.plan.TaskImpl,
| NewTask | | public interface NewTask extends Task,NewPlanningDirective(Code) | | NewTask Interface
Provide setters for building Task objects.
Task is the essential "execute" directive,
instructing a subordinate or service provider
to plan and eventually accomplish a task.
A the general form of a task is:
Verb DirectObject {PrepositionalPhrase}* per Schedule per Constraints
Note that these accessors are only well defined with respect to threading and
Blackboard transactions prior to the close of the transaction in which the
Task is added.
|
| addObservableAspect | | void addObservableAspect(int aspectType)(Code) | | Add to the collection of observable aspect types
|
| addPreference | | void addPreference(Preference aPreference)(Code) | | alias for setPreference. Multiple preferences of the same type are
not allowed so setPreference and addPreference are equivalent.
|
| addPrepositionalPhrase | | void addPrepositionalPhrase(PrepositionalPhrase aPrepPhrase)(Code) | | Adds a PrepositionalPhrase to the existing set of
PrepositionalPhrases of the task - an existing PrepositionalPhrases
with the same Preposition will be replaced.
Parameters:
aPrepPhrase - - The Prep Phrase of the Task. |
| setAuxiliaryQueryTypes | | void setAuxiliaryQueryTypes(int[] thetypes)(Code) | | Set the collection of AuxiliaryQueryTypes that the task is
requesting information on. This information will be returned in
the AllocationResult of this task's disposition.
Note that this method clears all previous types.
Parameters:
thetypes - A collection of defined AuxiliaryQueryTypes
See Also: org.cougaar.planning.ldm.plan.AuxiliaryQueryType |
| setCommitmentDate | | void setCommitmentDate(Date commitDate)(Code) | | Set the Commitment date of this task.
After this date, the task is not allowed to be rescinded
or re-planned (change in preferences).
Parameters:
commitDate - |
| setDeleted | | void setDeleted(boolean newDeleted)(Code) | | Set the deleted status of this task
|
| setDirectObject | | void setDirectObject(Asset dobj)(Code) | | Sets the Asset (or AssetGroup) that is being acted upon
by the Task. For example, in the task "fuel
vehicle 14 ..." the direct object is "vehicle 14".
Parameters:
dobj - - The DirectObject of the Task. |
| setParentTaskUID | | void setParentTaskUID(UID ptuid)(Code) | | Sets the base or parent task of
a given task, where the given task is
an expansion of the base task. The
parent task could be "move vehicles
from point a to point b ...". An
expanded task could be "fuel vehicles ...".
Parameters:
ptuid - - Task that is the "parenttask" |
| setPlan | | void setPlan(Plan aPlan)(Code) | | The Plan slot is unused and will be removed.
|
| setPreference | | void setPreference(Preference thePreference)(Code) | | Set just one preference in the task's preference list.
Implicit collection of detailed Task.PreferenceChangeReport instances.
|
| setPreferences | | void setPreferences(Enumeration thepreferences)(Code) | | set the preferences on this task.
Implicit collection of generic Task.PreferenceChangeReport instances.
Implicit collection of detailed ChangeReports without old value.
Parameters:
thepreferences - |
| setPrepositionalPhrase | | void setPrepositionalPhrase(PrepositionalPhrase aPrepPhrase)(Code) | | Makes the parameter the single prepositional phrase
of the task. Any previously-set prepositional phrases
are dropped.
A PrepositionalPhrase object contains a String
representation of the preposition (from, to, with, etc.)
and an object representing the indirect object. The indirect
object can be an Asset (or AssetGroup), a Location (or two) or
a Capabiltiy.
For example, in the task
"UnitA requisitions commodityB from UnitC"...
the PrepositionalPhrase is "from UnitC".
Parameters:
aPrepPhrase - - The Prep Phrase of the Task. |
| setPrepositionalPhrases | | void setPrepositionalPhrases(Enumeration enumOfPrepPhrase)(Code) | | Sets the prepositional phrases of the Task.
A PrepositionalPhrase object contains a String
representation of the preposition (from, to, with, etc.)
and an object representing the indirect object. The indirect
object can be an Asset (or AssetGroup), a Location (or two) or
a Capabiltiy.
For example, in the task
"UnitA requisitions commodityB from UnitC"...
the PrepositionalPhrase is "from UnitC".
Parameters:
enumOfPrepPhrase - - The Prep Phrases of the Task. |
| setPrepositionalPhrases | | void setPrepositionalPhrases(PrepositionalPhrase aPrepPhrase)(Code) | | Makes the parameter the single prepositional phrase
of the task. Any previously-set prepositional phrases
are dropped.
A PrepositionalPhrase object contains a String
representation of the preposition (from, to, with, etc.)
and an object representing the indirect object. The indirect
object can be an Asset (or AssetGroup), a Location (or two) or
a Capabiltiy.
For example, in the task
"UnitA requisitions commodityB from UnitC"...
the PrepositionalPhrase is "from UnitC".
Parameters:
aPrepPhrase - - The Prep Phrase of the Task. |
| setPriority | | void setPriority(byte thepriority)(Code) | | Set the priority of this task.
Note that this should only be used when there are competing tasks
from the SAME customer.
Parameters:
thepriority -
See Also: org.cougaar.planning.ldm.plan.Priority |
| setVerb | | void setVerb(Verb aVerb)(Code) | | The setVerb method sets the verb of the Task.
For example, in the Task "fuel vehicles...", the
Verb is the object represented by "fuel".
Parameters:
aVerb - - The verb of the Task. |
| setWorkflow | | void setWorkflow(Workflow aWorkflow)(Code) | | Set the Workflow that the task is a member of.
All Tasks are members of
a Workflow. The tasks that are expansions
of a basetask are placed in one workflow.
For example, the fueltask will be a member
of a workflow that contains all of the tasks
and constraints needed to complete the basetask.
Parameters:
aWorkflow - - The Workflow of the Task. |
|
|