Java Doc for ActiveTool.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » tool » api » 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 » ERP CRM Financial » sakai » org.sakaiproject.tool.api 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.sakaiproject.tool.api.ActiveTool

ActiveTool
public interface ActiveTool extends Tool(Code)

Extension to tool to introduce Servlet API specific tool activity.



Field Summary
final static  StringTOOL_ATTR_CURRENT_DESTINATION
     A tool session attribute where the placement's current destination (URL path) is stored.


Method Summary
 voidforward(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath)
    
 voidhelp(HttpServletRequest req, HttpServletResponse res, String toolContext, String toolPath)
     Invoke the tool to handle the complete request as a helper.
 voidinclude(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath)
    

Field Detail
TOOL_ATTR_CURRENT_DESTINATION
final static String TOOL_ATTR_CURRENT_DESTINATION(Code)
A tool session attribute where the placement's current destination (URL path) is stored.





Method Detail
forward
void forward(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath) throws ToolException(Code)
Invoke the tool to handle the complete request
Parameters:
  req - The request.
Parameters:
  res - The response.
Parameters:
  placement - The tool placement for this request.
Parameters:
  toolContext - The (optional) servlet context path that is given to the tool.
Parameters:
  toolPath - The (optional) servlet pathInfo that is given to the tool.
throws:
  ToolException - if there's any trouble running the tool.



help
void help(HttpServletRequest req, HttpServletResponse res, String toolContext, String toolPath) throws ToolException(Code)
Invoke the tool to handle the complete request as a helper. Note, the placement is shared between invoker and invoked.
Parameters:
  req - The request.
Parameters:
  res - The response.
Parameters:
  toolContext - The (optional) servlet context path that is given to the tool.
Parameters:
  toolPath - The (optional) servlet pathInfo that is given to the tool.
throws:
  ToolException - if there's any trouble running the tool.



include
void include(HttpServletRequest req, HttpServletResponse res, Placement placement, String toolContext, String toolPath) throws ToolException(Code)
Invoke the tool to handle the request by producing a fragment
Parameters:
  req - The request.
Parameters:
  res - The response.
Parameters:
  placement - The tool placement for this request.
Parameters:
  toolContext - The (optional) servlet context path that is given to the tool.
Parameters:
  toolPath - The (optional) servlet pathInfo that is given to the tool.
throws:
  ToolException - if there's any trouble running the tool.



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