Java Doc for AbstractExecutionObject.java in » Workflow-Engines » wfmopen-2.1.1 » de » danet » an » workflow » domain » 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

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL 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.domain

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

de.danet.an.workflow.domain .AbstractExecutionObject

All known Subclasses:   de.danet.an.workflow.domain .AbstractActivity,  de.danet.an.workflow.domain .AbstractProcess,
AbstractExecutionObject
abstract public class AbstractExecutionObject implements WfExecutionObjectLocal,ExtExecutionObjectLocal(Code)
AbstractExecutionObject represents a base implementation of the interface de.danet.an.workflow.api.ExecutionObjectExecutionObject .
With logger level DEBUG, event handling information will be logged.

Method Summary
public void abort()

abstract protected WfAuditEvent auditEventBase(String eventType)
     Returns a WfAuditEvent containing information about the execution object.
public void changeState(String newState)
     Updates the current state of the execution object.
public void changeState(State newState)
     Updates the current state of the execution object.
public boolean debugEnabled()
     Checks if the execution object is in debugging mode.
public String description()
     Returns the description of the execution object.
protected void dispose()
     Releases all allocated resources.
protected void fireAuditEvent(WfAuditEvent event)
     Process newly generated event.
abstract protected int getPaAuditEventSelection()
     The getter method for the persistent attribute auditEventSelection.
abstract protected boolean getPaDebug()
     The getter method for the persistent attribute debug.
abstract protected String getPaDescription()
     The getter method for the persistent attribute description.
abstract protected String getPaKey()
     The getter method for the persistent attribute key.
abstract protected Date getPaLastStateTime()
     The getter method for the persistent attribute lastStateTime.
abstract protected String getPaName()
     The getter method for the persistent attribute name.
abstract protected Priority getPaPriority()
     The getter method for the persistent attribute priority.
abstract protected boolean getPaStoreAuditEvents()
     The getter method for the persistent attribute storeAuditEvents.
abstract protected State getPaTypedState()
     The getter method for the persistent attribute typedState.
abstract protected Map getStateTransitionMap()
     Returns the java.util.Map Map that maps the execution object states to a java.util.MapList of reachable process states.
protected void handleAbortedEvent(WfStateAuditEvent event)
     Handles a aborting audit event.
public void handleAuditEvent(WfAuditEvent event)
     Handles the given audit event.
protected void handleCompletedEvent(WfStateAuditEvent event)
     Handles a completed audit event.
protected void handleImplCompletedEvent(ImplCompleteAuditEvent event)
     Handles a tool completed audit event.
protected void handleResumedEvent(WfStateAuditEvent event)
     Handles a resumed audit event.
protected void handleStartedEvent(WfStateAuditEvent event)
     Handles a started audit event.
protected void handleStateAuditEvent(WfAuditEvent event)
     Handles a state audit event, this includes ImplCompleteAuditEvents.
protected void handleSuspendedEvent(WfStateAuditEvent event)
     Handles a suspended audit event.
protected void handleTerminatedEvent(WfStateAuditEvent event)
     Handles a terminated audit event.
protected void handleToolInvocationFailedAuditEvent(ToolInvocationFailedAuditEvent event)
     Handles a tool invocation failed audit event.
public int hashCode()
     Returns a hash code value for this object.
Note that stubs do not in general implement hashCode correctly, so even if two execution objects are equal (this.equals(obj) is true) this.hashCode() need not be equal to obj.hashCode().
abstract public Collection history()

public State howClosed()
     Returns the workflow substate for closed execution objects.
protected void init()
     Initializes the class, i.e.
public String key()
     Returns the key of the execution object.
public Date lastStateTime()
     Returns the last state time of the execution object.
public String name()
     Returns the name of the execution object.
public int priority()
     Returns the priority of the execution object.
protected void refresh()
     Called after change of persistent attributes.
public void resume()

public void setDebugEnabled(boolean debug)
     Enable or disable debugging of the execution object.
public void setDescription(String newValue)
     Set a new description of the execution object.
public void setName(String newValue)
     Set a new name of the execution object.
abstract protected void setPaAuditEventSelection(int newAuditEventSelection)
     The setter method for the persistent attribute auditEventSelection.
abstract protected void setPaDebug(boolean newDebug)
     The setter method for the persistent attribute debug.
abstract protected void setPaDescription(String newDescription)
     The setter method for the persistent attribute description.
abstract protected void setPaLastStateTime(Date newLastStateTime)
     The setter method for the persistent attribute lastStateTime.
abstract protected void setPaName(String newName)
     The setter method for the persistent attribute name.
abstract protected void setPaPriority(Priority newPriority)
     The setter method for the persistent attribute priority.
abstract protected void setPaStoreAuditEvents(boolean newStoreAuditEvents)
     The setter method for the persistent attribute storeAuditEvents.
abstract protected void setPaTypedState(State newTypedState)
     The setter method for the persistent attribute typedState.
public void setPriority(int newValue)
     For the first iteration throws an UpdateNotAllowedException.
public void setProcessContext(ProcessData newValues)
     Updates process context of the execution object.
public String state()
     Returns the string representation of the state.
public void suspend()

public void terminate()

public State typedState()
     Returns the internal state, i.e.
protected void updateImmediate(State newState)
     Like AbstractExecutionObject.updateState updateState this method sets the state of this object and fires a state change event.
protected void updateInterim(State newState)
     Like AbstractExecutionObject.updateState updateState this method sets the state of this object and fires a state change event.
protected void updateState(State newState)
     Sets the state of this object.
public Collection validStates()
     Returns a list of all the valid states as strings that can be reached from the current state.
protected Collection validTypedStates()
     Returns a list of all the valid states (as State objects) that can be reached from the current state.
public State whileOpen()
     Returns the workflow substate for open execution objects.
public State whyNotRunning()
     Returns the workflow substate for open, not running execution objects.
public State workflowState()
     Returns the workflow state.

Method Detail
abort
public void abort() throws CannotStopException, NotRunningException(Code)

auditEventBase
abstract protected WfAuditEvent auditEventBase(String eventType)(Code)
Returns a WfAuditEvent containing information about the execution object.
Parameters:
  eventType - event type the event containing the required information.

changeState
public void changeState(String newState) throws 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. This implementation effectively calls ExecutionObjectLocal.changeStatechangeState(State) after converting the argument to State. Derived classes therefore only need to override changeState(State).
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.

changeState
public void changeState(State newState) throws InvalidStateException, TransitionNotAllowedException(Code)
Updates the current state of the execution object. As a result the state of execution objects associated with this execution object may be updated, too. This method uses the State class to represent states.
Parameters:
  newState - the new state.
throws:
  InvalidStateException - If newState is an invalidstate for the execution object.
throws:
  TransitionNotAllowedException - If the transition from the currentstate to newState is not allowed.

debugEnabled
public boolean debugEnabled()(Code)
Checks if the execution object is in debugging mode. true if the execution object is indebugging mode

description
public String description()(Code)
Returns the description of the execution object. description of the execution object

dispose
protected void dispose()(Code)
Releases all allocated resources. The object will be in an unusable state until resources are reallocated by calling AbstractExecutionObject.init init and AbstractExecutionObject.refresh refresh .

fireAuditEvent
protected void fireAuditEvent(WfAuditEvent event)(Code)
Process newly generated event. This fall-back implementation logs the event with level DEBUG and calls handlers for state change events. If the event source is an AbstractProcess its handleAuditEvent is called. If the event source is an AbstractActivity both the activity's and the process' handler are called.
This implementation is mainly intended for unit tests on the domain level. It must be overridden by the derived classes.
Parameters:
  event - Event

getPaAuditEventSelection
abstract protected int getPaAuditEventSelection()(Code)
The getter method for the persistent attribute auditEventSelection. the value of auditEventSelection.
See Also:   AbstractExecutionObject.setPaAuditEventSelection

getPaDebug
abstract protected boolean getPaDebug()(Code)
The getter method for the persistent attribute debug. the value of debug.
See Also:   AbstractExecutionObject.setPaDebug

getPaDescription
abstract protected String getPaDescription()(Code)
The getter method for the persistent attribute description. the value of description.
See Also:   AbstractExecutionObject.setPaDescription

getPaKey
abstract protected String getPaKey()(Code)
The getter method for the persistent attribute key. the value of key.

getPaLastStateTime
abstract protected Date getPaLastStateTime()(Code)
The getter method for the persistent attribute lastStateTime. This attribute holds the time when the state was last changed. This may happen from an explicit action like the complete() method or via a state change propagation from another WfmExecutionObject. the value of lastStateTime.
See Also:   AbstractExecutionObject.setPaLastStateTime

getPaName
abstract protected String getPaName()(Code)
The getter method for the persistent attribute name. the value of name.
See Also:   AbstractExecutionObject.setPaName

getPaPriority
abstract protected Priority getPaPriority()(Code)
The getter method for the persistent attribute priority. the value of priority.
See Also:   AbstractExecutionObject.setPaPriority

getPaStoreAuditEvents
abstract protected boolean getPaStoreAuditEvents()(Code)
The getter method for the persistent attribute storeAuditEvents. the value of storeAuditEvents.
See Also:   AbstractExecutionObject.setPaStoreAuditEvents

getPaTypedState
abstract protected State getPaTypedState()(Code)
The getter method for the persistent attribute typedState. the value of typedState.
See Also:   AbstractExecutionObject.setPaTypedState

getStateTransitionMap
abstract protected Map getStateTransitionMap()(Code)
Returns the java.util.Map Map that maps the execution object states to a java.util.MapList of reachable process states.
The map returns the state transitions allowed as parameters of de.danet.an.workflow.localcoreapi.WfExecutionObjectLocal.changeStatechangeState only. I.e. the map does not reflect all possible transitions, there may be more, but those are only accessible to the workflow engine itself. the resulting map.

handleAbortedEvent
protected void handleAbortedEvent(WfStateAuditEvent event)(Code)
Handles a aborting audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleAuditEvent
public void handleAuditEvent(WfAuditEvent event)(Code)
Handles the given audit event. The fall back implementation simply calls AbstractExecutionObject.handleStateAuditEvent if the event source is this object and the event is a WfStateAuditEvent or a ToolCompletedAuditEvent .
Parameters:
  event - the event.

handleCompletedEvent
protected void handleCompletedEvent(WfStateAuditEvent event)(Code)
Handles a completed audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleImplCompletedEvent
protected void handleImplCompletedEvent(ImplCompleteAuditEvent event)(Code)
Handles a tool completed audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleResumedEvent
protected void handleResumedEvent(WfStateAuditEvent event)(Code)
Handles a resumed audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleStartedEvent
protected void handleStartedEvent(WfStateAuditEvent event)(Code)
Handles a started audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleStateAuditEvent
protected void handleStateAuditEvent(WfAuditEvent event)(Code)
Handles a state audit event, this includes ImplCompleteAuditEvents. This implementation simply calls the appropriate handler method handleTransitionEvent.
Parameters:
  event - the event.

handleSuspendedEvent
protected void handleSuspendedEvent(WfStateAuditEvent event)(Code)
Handles a suspended audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleTerminatedEvent
protected void handleTerminatedEvent(WfStateAuditEvent event)(Code)
Handles a terminated audit event. The default implementation does nothing.
Parameters:
  event - the event.

handleToolInvocationFailedAuditEvent
protected void handleToolInvocationFailedAuditEvent(ToolInvocationFailedAuditEvent event)(Code)
Handles a tool invocation failed audit event. The default implementation does nothing.
Parameters:
  event - the event.

hashCode
public int hashCode()(Code)
Returns a hash code value for this object.
Note that stubs do not in general implement hashCode correctly, so even if two execution objects are equal (this.equals(obj) is true) this.hashCode() need not be equal to obj.hashCode(). the hash code value.

history
abstract public Collection history() throws HistoryNotAvailableException(Code)

howClosed
public State howClosed()(Code)
Returns the workflow substate for closed execution objects. the workflow substate.

init
protected void init()(Code)
Initializes the class, i.e. resets all attributes to default values. Note that AbstractExecutionObject.refresh refresh will be called subsequently.
See Also:   AbstractExecutionObject.dispose

key
public String key()(Code)
Returns the key of the execution object. key of the execution object

lastStateTime
public Date lastStateTime()(Code)
Returns the last state time of the execution object. last state time of the execution object

name
public String name()(Code)
Returns the name of the execution object. name of the execution object

priority
public int priority()(Code)
Returns the priority of the execution object. priority of the execution object

refresh
protected void refresh()(Code)
Called after change of persistent attributes. May be used to synchronise state derived from persistent attributes with the new values.
See Also:   AbstractExecutionObject.init

resume
public void resume() throws CannotResumeException, NotRunningException, NotSuspendedException(Code)

setDebugEnabled
public void setDebugEnabled(boolean debug) throws InvalidStateException(Code)
Enable or disable debugging of the execution object.
Parameters:
  debug - if the execution object is to be debugged
throws:
  InvalidStateException - if changing debug mode is notallowed

setDescription
public void setDescription(String newValue)(Code)
Set a new description of the execution object.
Parameters:
  newValue - new description
See Also:   AbstractExecutionObject.description

setName
public void setName(String newValue)(Code)
Set a new name of the execution object.
Parameters:
  newValue - new name.
See Also:   AbstractExecutionObject.name

setPaAuditEventSelection
abstract protected void setPaAuditEventSelection(int newAuditEventSelection)(Code)
The setter method for the persistent attribute auditEventSelection.
Parameters:
  newAuditEventSelection - the new value ofauditEventSelection.
See Also:   AbstractExecutionObject.getPaAuditEventSelection

setPaDebug
abstract protected void setPaDebug(boolean newDebug)(Code)
The setter method for the persistent attribute debug.
Parameters:
  newDebug - the new value of debug.
See Also:   AbstractExecutionObject.getPaDebug

setPaDescription
abstract protected void setPaDescription(String newDescription)(Code)
The setter method for the persistent attribute description.
Parameters:
  newDescription - the new value of description.
See Also:   AbstractExecutionObject.getPaDescription

setPaLastStateTime
abstract protected void setPaLastStateTime(Date newLastStateTime)(Code)
The setter method for the persistent attribute lastStateTime.
Parameters:
  newLastStateTime - the new value of lastStateTime.
See Also:   AbstractExecutionObject.getPaLastStateTime

setPaName
abstract protected void setPaName(String newName)(Code)
The setter method for the persistent attribute name.
Parameters:
  newName - the new value of name.
See Also:   AbstractExecutionObject.getPaName

setPaPriority
abstract protected void setPaPriority(Priority newPriority)(Code)
The setter method for the persistent attribute priority.
Parameters:
  newPriority - the new value of priority.
See Also:   AbstractExecutionObject.getPaPriority

setPaStoreAuditEvents
abstract protected void setPaStoreAuditEvents(boolean newStoreAuditEvents)(Code)
The setter method for the persistent attribute storeAuditEvents.
Parameters:
  newStoreAuditEvents - the new value of storeAuditEvents.
See Also:   AbstractExecutionObject.getPaStoreAuditEvents

setPaTypedState
abstract protected void setPaTypedState(State newTypedState)(Code)
The setter method for the persistent attribute typedState.
Parameters:
  newTypedState - the new value of typedState.
See Also:   AbstractExecutionObject.getPaTypedState

setPriority
public void setPriority(int newValue) throws InvalidPriorityException, UpdateNotAllowedException(Code)
For the first iteration throws an UpdateNotAllowedException.
Parameters:
  newValue - new priority
throws:
  InvalidPriorityException - when the specified priority is out of range.
throws:
  UpdateNotAllowedException - when the priority cannot be updated.

setProcessContext
public void setProcessContext(ProcessData newValues) throws InvalidDataException, UpdateNotAllowedException(Code)
Updates process context of the execution object.
Parameters:
  newValues - the name-value pairs to be set.
throws:
  InvalidDataException - If a name or value type does not matchthe signature of this process.
throws:
  UpdateNotAllowedException - If the update is not allowed.

state
public String state()(Code)
Returns the string representation of the state. string representation of the state.

suspend
public void suspend() throws CannotSuspendException, NotRunningException, AlreadySuspendedException(Code)

terminate
public void terminate() throws CannotStopException, NotRunningException(Code)

typedState
public State typedState()(Code)
Returns the internal state, i.e. the state represented as State object. internal state.
See Also:   AbstractExecutionObject.updateState

updateImmediate
protected void updateImmediate(State newState)(Code)
Like AbstractExecutionObject.updateState updateState this method sets the state of this object and fires a state change event. The state change event will, however, not be fed back to the engine, i.e. it will not lead to follow up activities.
The method is intended to be used in cases where the engine triggers a state change itself and also performs all actions that are usually done in the event handling method.
Parameters:
  newState - new state.
See Also:   AbstractExecutionObject.typedState

updateInterim
protected void updateInterim(State newState)(Code)
Like AbstractExecutionObject.updateState updateState this method sets the state of this object and fires a state change event. The state change event will, however, not be fed back to the engine, i.e. it will not lead to follow up activities and the last state time will not be updated.
The method is intended to be used for an interim state change, i.e. the caller knows that the state will change again before the transaction is completed.
Parameters:
  newState - new state.
See Also:   AbstractExecutionObject.typedState

updateState
protected void updateState(State newState)(Code)
Sets the state of this object. The method updates the last state time and fires a state change event.
Parameters:
  newState - new state.
See Also:   AbstractExecutionObject.typedState

validStates
public Collection validStates()(Code)
Returns a list of all the valid states as strings that can be reached from the current state. If there is no valid state, the collection will be empty. list of all the valid states

validTypedStates
protected Collection validTypedStates()(Code)
Returns a list of all the valid states (as State objects) that can be reached from the current state. If there is no valid state, the collection will be empty. list of all the valid states

whileOpen
public State whileOpen()(Code)
Returns the workflow substate for open execution objects. the workflow substate.

whyNotRunning
public State whyNotRunning()(Code)
Returns the workflow substate for open, not running execution objects. the workflow substate.

workflowState
public State workflowState()(Code)
Returns the workflow state. the workflow state.

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.