Java Doc for WfExecutionObject.java in  » Workflow-Engines » wfmopen-2.1.1 » de » danet » an » workflow » omgcore » 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 » wfmopen 2.1.1 » de.danet.an.workflow.omgcore 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


de.danet.an.workflow.omgcore.WfExecutionObject

WfExecutionObject
public interface WfExecutionObject extends WfObject,Serializable(Code)
WfExecutionObject is an abstract base interface that defines common attributes, states, and operations for de.danet.an.workflow.omgcore.WfProcess WfProcess and de.danet.an.workflow.omgcore.WfActivity WfActivity .

Inner Class :public static class State implements Serializable
Inner Class :public static class OpenState extends WfExecutionObject.State implements Serializable
Inner Class :public static class NotRunningState extends OpenState implements Serializable
Inner Class :public static class ClosedState extends State implements Serializable



Method Summary
 voidabort()
     Requests enactment of a suspended execution object to be aborted before its normal completion.
 voidchangeState(String newState)
     Updates the current state of the execution object.
 Stringdescription()
     Get the description of this WfExecutionObject.
 Collectionhistory()
     Return all WfAuditEvent items associated with this execution object.
 StatehowClosed()
     Returns the workflow state for closed execution objects.
 Stringkey()
     Identifier of the execution object.
 DatelastStateTime()
     Return the time the state of the WfExecutionObject was changed.
 Stringname()
     Return human readable, descriptive identifier of the execution object.
 intpriority()
     Return the priority of this WfExecutionObject.
 ProcessDataprocessContext()
     Return the context of this WfExecutionObject.
 voidresume()
     Requests enactment of a suspended execution object to be resumed.
 voidsetDescription(String newValue)
     Set the description of this WfExecutionObject.
 voidsetName(String newValue)
     Set the name of this WfExecutionObject.
 voidsetPriority(int newValue)
     Update the priority of this WfExecutionObject.
 voidsetProcessContext(ProcessData newValue)
     Set the context of this WfExecutionObject.
 Stringstate()
     Gets the current state of the object.
 voidsuspend()
     Requests enactment of an execution object to be suspended.
 voidterminate()
     Requests enactment of an execution object to be terminated before its normal completion.
 CollectionvalidStates()
     Returns a list of all the valid states that can be reached from the current state.
 StatewhileOpen()
     Returns the workflow state for open execution objects.
 StatewhyNotRunning()
     Returns the workflow state for open, not running execution objects.
 StateworkflowState()
     Return the current state.



Method Detail
abort
void abort() throws RemoteException, CannotStopException, NotRunningException(Code)
Requests enactment of a suspended execution object to be aborted before its normal completion. The state is set to ClosedState.ABORTED.
throws:
  RemoteException - if a system-level error occurs.
throws:
  CannotStopException - when the execution object cannot be aborted.
throws:
  NotRunningException - when the object is not running.



changeState
void changeState(String newState) throws RemoteException, InvalidStateException, TransitionNotAllowedException(Code)
Updates the current state of the execution object. As a result the state of execution objects associated with this execution object might be updated, too.
Parameters:
  newState - State to change to.
throws:
  InvalidStateException - If newState is an invalidstate for the execution object.
throws:
  TransitionNotAllowedException - If the transition from the currentstate to newState is not allowed.
throws:
  RemoteException - If a communication error occurred.



description
String description() throws RemoteException(Code)
Get the description of this WfExecutionObject. a string value of the description.
throws:
  RemoteException - If a communication error occurred.



history
Collection history() throws RemoteException, HistoryNotAvailableException(Code)
Return all WfAuditEvent items associated with this execution object. the collection of all WfAuditEvent items.
throws:
  RemoteException - if a system-level error occurs.
throws:
  HistoryNotAvailableException - if any audit event item available.



howClosed
State howClosed() throws RemoteException(Code)
Returns the workflow state for closed execution objects. the state as State object.
throws:
  RemoteException - If a communication error occurred.



key
String key() throws RemoteException(Code)
Identifier of the execution object. string of the identifier.
throws:
  RemoteException - If a communication error occurred.



lastStateTime
Date lastStateTime() throws RemoteException(Code)
Return the time the state of the WfExecutionObject was changed. value of the time.
throws:
  RemoteException - if a system-level error occurs.



name
String name() throws RemoteException(Code)
Return human readable, descriptive identifier of the execution object. string of the descriptive identifier.
throws:
  RemoteException - If a communication error occurred.



priority
int priority() throws RemoteException(Code)
Return the priority of this WfExecutionObject. the value of the priority.
throws:
  RemoteException - if a system-level error occurs.



processContext
ProcessData processContext() throws RemoteException(Code)
Return the context of this WfExecutionObject. the process relevant data that define the context of the execution object.
throws:
  RemoteException - If a communication error occurred.



resume
void resume() throws RemoteException, CannotResumeException, NotRunningException, NotSuspendedException(Code)
Requests enactment of a suspended execution object to be resumed. The state is set to OpenState.Running (or a substate) from NotRunningState.SUSPENDED.
throws:
  RemoteException - if a system-level error occurs.
throws:
  CannotResumeException - when the execution object cannot be resumed. For example, resuming a WfActivity might not be allowed when the containing WfProcess is suspended.
throws:
  NotRunningException - when the object is not running.
throws:
  NotSuspendedException - when the object is not suspended.



setDescription
void setDescription(String newValue) throws RemoteException(Code)
Set the description of this WfExecutionObject.
Parameters:
  newValue - the description of this WfExecutionObject.
throws:
  RemoteException - If a communication error occurred.



setName
void setName(String newValue) throws RemoteException(Code)
Set the name of this WfExecutionObject.
Parameters:
  newValue - the description of this WfExecutionObject.
throws:
  RemoteException - If a communication error occurred.



setPriority
void setPriority(int newValue) throws RemoteException, InvalidPriorityException, UpdateNotAllowedException(Code)
Update the priority of this WfExecutionObject.
Parameters:
  newValue - new priority to set
throws:
  RemoteException - if a system-level error occurs.
throws:
  InvalidPriorityException - when the specified priority is out of range.
throws:
  UpdateNotAllowedException - when the priority cannot be updated.



setProcessContext
void setProcessContext(ProcessData newValue) throws RemoteException, InvalidDataException, UpdateNotAllowedException(Code)
Set the context of this WfExecutionObject.
Parameters:
  newValue - process relevant data that define the context of the execution object.
throws:
  RemoteException - if a system-level error occurs.
throws:
  InvalidDataException - when new process data does not match the signature of this WfExecutionObject.
throws:
  UpdateNotAllowedException - raised when the implementation of theWfM Facility or the specific workflow process does not allow an update of the context.



state
String state() throws RemoteException(Code)
Gets the current state of the object. the current state.
throws:
  RemoteException - If a communication error occurred.



suspend
void suspend() throws RemoteException, CannotSuspendException, NotRunningException, AlreadySuspendedException(Code)
Requests enactment of an execution object to be suspended. The state is set to NotRunningState.SUSPENDED (or one of its substates).
throws:
  RemoteException - if a system-level error occurs.
throws:
  CannotSuspendException - when the execution object cannot besuspended. For example, an implementation of the WfM Facility might notsupport suspension of a WfActivity.
throws:
  NotRunningException - when the object is not running.
throws:
  AlreadySuspendedException - when the object is already suspended.



terminate
void terminate() throws RemoteException, CannotStopException, NotRunningException(Code)
Requests enactment of an execution object to be terminated before its normal completion.
throws:
  RemoteException - if a system-level error occurs.
throws:
  CannotStopException - when the execution object cannot be aborted.
throws:
  NotRunningException - when the object is not running.



validStates
Collection validStates() throws RemoteException(Code)
Returns a list of all the valid states that can be reached from the current state. A java.util.Collection collection ofall the valid states.
throws:
  RemoteException - If a communication error occurred.



whileOpen
State whileOpen() throws RemoteException(Code)
Returns the workflow state for open execution objects. the state as State object.
throws:
  RemoteException - if a system-level error occurs.



whyNotRunning
State whyNotRunning() throws RemoteException(Code)
Returns the workflow state for open, not running execution objects. the state as State object.
throws:
  RemoteException - if a system-level error occurs.



workflowState
State workflowState() throws RemoteException(Code)
Return the current state. the current state.
throws:
  RemoteException - if a system-level error occurs.



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