Java Doc for ToolAgent.java in  » Workflow-Engines » obe-1.0 » org » obe » client » api » tool » 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 » Workflow Engines » obe 1.0 » org.obe.client.api.tool 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.obe.client.api.tool.ToolAgent

All known Subclasses:   org.obe.runtime.tool.AbstractToolAgent,
ToolAgent
public interface ToolAgent (Code)
Enables the workflow engine or a client to invoke a tool (application or procedure). Implementations can be stateful only to the extent of containing service configuration information; their methods must be threadsafe.
author:
   Adrian Price


Field Summary
 intACTIVE
     The tool is active.
 intERROR
     The agent or tool encountered an error.
 intEXIT_CANCEL
     The tool was cancelled by the user.
 intEXIT_NORMAL
     The tool finished normally.
 intFINISHED
     The tool has finished running.
 intRUNNING
     The tool agent is running.
 intTERMINATED
     The tool was terminated.
 intWAITING
     The tool has not yet been invoked.


Method Summary
 intinvokeApplication(ToolInvocation ti)
     Invokes the tool.
 voidrenderInvocationScript(ToolInvocation ti, Writer writer)
     Renders the JavaScript necessary to invoke the tool from an HTML browser.
 intrequestAppStatus()
     Returns the tool status.
 voidterminateApp()
     Terminates the running tool.

Field Detail
ACTIVE
int ACTIVE(Code)
The tool is active.



ERROR
int ERROR(Code)
The agent or tool encountered an error.



EXIT_CANCEL
int EXIT_CANCEL(Code)
The tool was cancelled by the user.



EXIT_NORMAL
int EXIT_NORMAL(Code)
The tool finished normally.



FINISHED
int FINISHED(Code)
The tool has finished running.



RUNNING
int RUNNING(Code)
The tool agent is running.



TERMINATED
int TERMINATED(Code)
The tool was terminated.



WAITING
int WAITING(Code)
The tool has not yet been invoked.





Method Detail
invokeApplication
int invokeApplication(ToolInvocation ti) throws InvocationTargetException(Code)
Invokes the tool. The implementation must update the values of any INOUT and OUT parameters appropriately, and should set the values of any IN parameters to null.
Parameters:
  ti - The tool invocation context. The tool's exit code. One of ToolAgent.EXIT_NORMAL,ToolAgent.EXIT_CANCEL.
throws:
  IllegalStateException - if the ToolAgent is not in theToolAgent.WAITING state.
throws:
  InvocationTargetException - As thrown prior to or during duringtool execution.



renderInvocationScript
void renderInvocationScript(ToolInvocation ti, Writer writer) throws IOException(Code)
Renders the JavaScript necessary to invoke the tool from an HTML browser.
Parameters:
  ti -
Parameters:
  writer -



requestAppStatus
int requestAppStatus()(Code)
Returns the tool status. One of: ToolAgent.WAITING, ToolAgent.RUNNING, ToolAgent.ACTIVE,ToolAgent.TERMINATED, ToolAgent.FINISHED.



terminateApp
void terminateApp()(Code)
Terminates the running tool.
throws:
  IllegalStateException - if the tool is not running.



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