Source Code Cross Referenced for FunctionProvider.java in  » Workflow-Engines » OSWorkflow » com » opensymphony » workflow » 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 » OSWorkflow » com.opensymphony.workflow 
Source Cross Referenced  Class Diagram Java Document (Java Doc) 


01:        /*
02:         * Copyright (c) 2002-2003 by OpenSymphony
03:         * All rights reserved.
04:         */
05:        package com.opensymphony.workflow;
06:
07:        import com.opensymphony.module.propertyset.PropertySet;
08:
09:        import java.util.Map;
10:
11:        /**
12:         * Interface to be implemented by any class that are to be called from within a workflow as a function,
13:         * either as a pre-function or a post-function. The args nested elements within the function xml call
14:         * will be mapped to the properties parameter.
15:         *
16:         * @author <a href="mailto:plightbo@hotmail.com">Pat Lightbody</a>
17:         */
18:        public interface FunctionProvider {
19:            //~ Methods ////////////////////////////////////////////////////////////////
20:
21:            /**
22:             * Execute this function
23:             * @param transientVars Variables that will not be persisted. These include inputs
24:             * given in the {@link Workflow#initialize} and {@link Workflow#doAction} method calls.
25:             * There are a number of special variable names:
26:             * <ul>
27:             * <li><code>entry</code>: (object type: {@link com.opensymphony.workflow.spi.WorkflowEntry})
28:             *  The workflow instance
29:             * <li><code>context</code>:
30:             * (object type: {@link com.opensymphony.workflow.WorkflowContext}). The workflow context.
31:             * <li><code>actionId</code>: The Integer ID of the current action that was take (if applicable).
32:             * <li><code>currentSteps</code>: A Collection of the current steps in the workflow instance.
33:             * <li><code>store</code>: The {@link com.opensymphony.workflow.spi.WorkflowStore}.
34:             * <li><code>descriptor</code>: The {@link com.opensymphony.workflow.loader.WorkflowDescriptor}.
35:             * </ul>
36:             * Also, any variable set as a {@link com.opensymphony.workflow.Register}), will also be
37:             * available in the transient map, no matter what. These transient variables only last through
38:             * the method call that they were invoked in, such as {@link Workflow#initialize}
39:             * and {@link Workflow#doAction}.
40:             * @param args The properties for this function invocation. Properties are created
41:             * from arg nested elements within the xml, an arg element takes in a name attribute
42:             * which is the properties key, and the CDATA text contents of the element map to
43:             * the property value.
44:             * @param ps The persistent variables that are associated with the current
45:             * instance of the workflow. Any change made to the propertyset are persisted to
46:             * the propertyset implementation's persistent store.
47:             */
48:            public void execute(Map transientVars, Map args, PropertySet ps)
49:                    throws WorkflowException;
50:        }
www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.