Java Doc for Task.java in  » Science » Cougaar12_4 » org » cougaar » planning » ldm » plan » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Science » Cougaar12_4 » org.cougaar.planning.ldm.plan 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.cougaar.planning.ldm.plan.Task

All known Subclasses:   org.cougaar.planning.ldm.plan.TaskImpl,
Task
public interface Task extends PlanningDirective,UniqueObject,Priority,Annotatable,Publishable(Code)
Task Interface 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 {PrepositionalPhrase} per per

Inner Class :interface TaskChangeReport extends ChangeReport
Inner Class :class PreferenceChangeReport implements TaskChangeReport
Inner Class :class PrepositionChangeReport implements TaskChangeReport



Method Summary
 booleanbeforeCommitment(Date currentdate)
     Check to see if the current time is before the Commitment date.
 int[]getAuxiliaryQueryTypes()
     Get a collection of the requested AuxiliaryQueryTypes (int).
 DategetCommitmentDate()
     WARNING: This method may return null if the commitment date is undefined. The task commitment date of a task represents the date past which the planning module will warn if the task is changed or removed.
 ContextgetContext()
     Get the problem Context (if any) for this task.
 AssetgetDirectObject()
     Returns the Asset (or AssetGroup) that is being acted upon by the Task.
 EnumerationgetObservableAspects()
    
 UIDgetParentTaskUID()
     Returns the UID of the base or parent task of a given task, where the given task is an expansion of the base task.
 PlangetPlan()
    
 PlanElementgetPlanElement()
     Returns PlanElement that this Task is associated with.
 PreferencegetPreference(int aspect_type)
    
 EnumerationgetPreferences()
     get the preferences on this task.
 doublegetPreferredValue(int aspect_type)
    
 PrepositionalPhrasegetPrepositionalPhrase(String preposition)
     Return the first PrepositionalPhrase found with the specified Preposition.
 EnumerationgetPrepositionalPhrases()
     Returns the prepositional phrase(s) of the Task.
 bytegetPriority()
     Get the priority of this task.
 VerbgetVerb()
     The getVerb method returns the verb of the Task.
 WorkflowgetWorkflow()
     All Tasks are members of a Workflow.
 booleanisDeleted()
     Get the deleted status of this task.



Method Detail
beforeCommitment
boolean beforeCommitment(Date currentdate)(Code)
Check to see if the current time is before the Commitment date. Will return true if we have not reached the commitment date. Will return true if the commitment date is undefined. Will return false if we have passed the commitment date.
Parameters:
  currentdate - The current date.



getAuxiliaryQueryTypes
int[] getAuxiliaryQueryTypes()(Code)
Get a collection of the requested AuxiliaryQueryTypes (int). Note: if there are no types set, this will return an array with one element = -1
See Also:   org.cougaar.planning.ldm.plan.AuxiliaryQueryType



getCommitmentDate
Date getCommitmentDate()(Code)
WARNING: This method may return null if the commitment date is undefined. The task commitment date of a task represents the date past which the planning module will warn if the task is changed or removed. Commitment dates in the planning domain are used to note the last possible date that a task could be changed before the supplier has committed resources to fill or commit the task. E.g. If a supplier has an order and ship lead time of 3 days, then the task's commitment date should be atleast 3 days before the desired delivery date (usually represented with an end date preference). Date The Commitment date of this task.



getContext
Context getContext()(Code)
Get the problem Context (if any) for this task.
See Also:   Context



getDirectObject
Asset getDirectObject()(Code)
Returns 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". the Direct Object of the task.



getObservableAspects
Enumeration getObservableAspects()(Code)



getParentTaskUID
UID getParentTaskUID()(Code)
Returns the UID of 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 ...". UID basetask = fueltask.getParentTaskUID(); UID of the Task that is the "parenttask"



getPlan
Plan getPlan()(Code)
Plan.RealityPlan -- this slot is unused / deprecated



getPlanElement
PlanElement getPlanElement()(Code)
Returns PlanElement that this Task is associated with. Can be used to discern between expandable and non-expandable Tasks. If Task has no PlanElement associated with it, will return null.



getPreference
Preference getPreference(int aspect_type)(Code)
return the preference for the given aspect type will return null if there is not a preference defined for this aspect type
Parameters:
  aspect_type - The Aspect referenced by the preference



getPreferences
Enumeration getPreferences()(Code)
get the preferences on this task. Enumeration{Preference}



getPreferredValue
double getPreferredValue(int aspect_type)(Code)
return the preferred value for a given aspect type from the defined preference (and scoring function) will return Double.NaN if there is not a preference defined for this aspect type
Parameters:
  aspect_type - The Aspect referenced by the preference



getPrepositionalPhrase
PrepositionalPhrase getPrepositionalPhrase(String preposition)(Code)
Return the first PrepositionalPhrase found with the specified Preposition. Returns null if not found.
Parameters:
  preposition - One of the strings named in org.cougaar.planning.ldm.plan.Preposition.



getPrepositionalPhrases
Enumeration getPrepositionalPhrases()(Code)
Returns the prepositional phrase(s) 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 will be an Asset which can represent an Asset, AssetGroup or Location. For example, in the task "UnitA requisitions commodityB from UnitC"... the PrepositionalPhrase is "from UnitC". An enumeration of PrepositionalPhrases
See Also:   Preposition



getPriority
byte getPriority()(Code)
Get the priority of this task. Note that this should only be used when there are competing tasks from the SAME customer. The priority of this task
See Also:   org.cougaar.planning.ldm.plan.Priority



getVerb
Verb getVerb()(Code)
The getVerb method returns the verb of the Task. For example, in the Task "fuel vehicles...", the Verb is the object represented by "fuel".
 Verb mytaskverb = fueltask.getVerb(); 
the Verb of the Task.



getWorkflow
Workflow getWorkflow()(Code)
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.
 Workflow myworkflow = fueltask.getWorkflow(); 
Workflow Returns the Workflow that the task is a member of.



isDeleted
boolean isDeleted()(Code)
Get the deleted status of this task.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.