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


de.danet.an.workflow.domain.AbstractProcess
   de.danet.an.workflow.ejbs.core.WfProcessEJB

WfProcessEJB
public class WfProcessEJB extends AbstractProcess implements EntityBean,TimedObject(Code)
The entity bean WfProcessEJB represent a process in the workflow.



Constructor Summary
public  WfProcessEJB()
     Contructor.

Method Summary
public  ActivityactivityByKey(String key)
     Returns the Activity Activity with the given key. The OMG interface only defines a WfProcess.steps method for listing all the activities associated with the process. While, of course, one could select the activity with a certain key from that list, this would be rather insufficient.
Parameters:
  key - the de.danet.an.workflow.omgcore.WfActivity.key key of the process.
public  ActivityLocalactivityByKeyLocal(String key)
     Returns the Activity ActivityLocal with the given key.
protected  WfAuditEventactivityRequesterInfo(WfRequester req)
     Retrieve the base event information about a requesting activity.
Parameters:
  req - the requester.
public  WfAuditEventauditEventBase()
     Returns an audit event object with process relevant information initialized.
protected  voidcloseChannels()
     Closes all channels.
public  voidcopyProcessDefinition(String procDefXpdl)
     Copy the process definition in xpdl string in this process.
protected  de.danet.an.workflow.localcoreapi.WfActivityLocalcreateActivity(String blockActId, Priority priority, String name, String description, StartFinishMode startMode, StartFinishMode finishMode, JoinAndSplitMode joinMode, JoinAndSplitMode splitMode, Implementation[] implementation, String performer, List deadlines, boolean deferChoiceOnSplit, int auditEventSelection, boolean storeAuditEvents)
     Factory method that create new persistent objects of type WfActivity.
protected  LongcreateActivityKey()
     Provide a new unique activity key.
public  booleandeliverChannelMessage(String channel, Map message)
     Deliver a message on the given channel to a receiver tool listening on that channel.
protected  TransitionLocaldoCreateTransition(String id, String group, int order, ActivityLocal fromAct, ActivityLocal toAct, int condType, String condition)
     Create a new transition with given id, from-activity, to-activity.
public  voidejbActivate()
     The activate method is called when the instance is activated from its "passive" state.
public  LongejbCreate(de.danet.an.workflow.api.ProcessDefinition procDef, WfRequester req)
     Create an process and save it into database.
public  CollectionejbFindAll()
     This method looks up all processes.
public  LongejbFindByActivityKey(String key)
     This method looks up a process by the key de.danet.an.workflow.omgcore.WfActivity.key key of one of its activities.
Parameters:
  key - the activity key.
public  LongejbFindByPrimaryKey(Long primaryKey)
     This method looks up a process EJB by its primary key (dbid).
Parameters:
  primaryKey - the process primary key.
public  LongejbFindByProcessKey(String key)
     This method looks up a process by its de.danet.an.workflow.omgcore.WfProcess.key key .
Parameters:
  key - the process key.
public  CollectionejbFindByProcessMgrName(String processMgrName)
     This method looks up all the process by its process type.
Parameters:
  processMgrName - the process type.
public  CollectionejbFindByProcessTypeAndDataItem(String processMgr, String itemName, String itemValue)
     Look up all processes of a given type that have a given value in a particular process data item.
public  CollectionejbFindByRequesterHash(int hash)
     This method looks up all processes that have a requester with the given hash value.
Parameters:
  hash - the hash value.
public  CollectionejbFindWithoutDefinitionByProcessMgrName(String processMgrName)
     This method looks up all processes without a local copy of the process definition by their process type.
Parameters:
  processMgrName - the process type.
public  voidejbLoad()
     A container invokes this method to synchronize the state of an enterprise bean instance with the entity object's state in the database.
public  voidejbPassivate()
     The passivate method is called before the instance enters the "passive" state.
public  voidejbPostCreate(ProcessDefinition procDef, WfRequester req)
     Create an process and save it into database.
public  voidejbRemove()
     A container invokes this method before it ends the life of the session object.
public  voidejbStore()
     A container invokes this method to synchronize the state of the entity object in the database with the state of the enterprise bean instancee.
public  voidejbTimeout(Timer timer)
     Handle the timeout of a timer.
public  booleanequals(Object obj)
     Indicates if some other object is equal to this one.
protected  voidfireAuditEvent(WfAuditEvent evt)
     Process newly generated event.
public  voidforwardAbandon(Activity activity, ExceptionResult result)
     Forward the state change to the given activity.
public  voidforwardAbort(Activity activity)
     Forward the state change to the given activity.
public  Activity.InfoforwardActivityInfo(Activity activity)
     Forward the request for the activity info to the given activity.
public  booleanforwardChoose(Activity activity)
     Choose the given activity for further processing in deferred choice.
public  voidforwardComplete(Activity activity)
     Forward the state change to the given activity.
public  voidforwardResult(Activity activity, ProcessData result)
     Forward the result to the given activity.
public  voidforwardStateChange(Activity activity, State state)
     Forward the state change to the given activity calling changeState.
public  voidforwardTerminate(Activity activity)
     Forward the state change to the given activity.
protected  intgetPaAuditEventSelection()
     The getter method implementation for the persistent attribute auditEventSelection.
protected  MapgetPaBlockDeadlines()
     The getter method implementation for the persistent attribute blockDeadlines.
protected  DategetPaCreateTime()
     The getter method implementation for the persistent attribute createTime.
protected  booleangetPaDebug()
     The getter method implementation for the persistent attribute debug.
protected  StringgetPaDescription()
     The getter method implementation for the persistent attribute description.
protected  StringgetPaId()
     The getter method implementation for the persistent attribute id.
protected  StringgetPaKey()
     The getter method implementation for the persistent attribute key.
protected  DategetPaLastStateTime()
     The getter method implementation for the persistent attribute lastStateTime.
protected  StringgetPaName()
     The getter method implementation for the persistent attribute name.
protected  PrioritygetPaPriority()
     The getter method implementation for the persistent attribute priority.
protected  ProcessDatagetPaProcessData()
     The getter method implementation for the persistent attribute processData.
protected  ProcessDefinitiongetPaProcessDef()
     The getter method implementation for the persistent attribute processDef.
protected  StringgetPaProcessMgrName()
     The getter method implementation for the persistent attribute processMgrName.
protected  StringgetPaProcessMgrVersion()
     The getter method implementation for the persistent attribute processMgrVersion.
protected  WfRequestergetPaRequester()
     The getter method implementation for the persistent attribute requester.
protected  booleangetPaStoreAuditEvents()
     The getter method implementation for the persistent attribute storeAuditEvents.
protected  StategetPaTypedState()
     The getter method implementation for the persistent attribute typedState.
public  inthashCode()
    
public  Collectionhistory()
     Returns a collection of WfAuditEvents associated with this process describing its history.
static  ListloadDeadlines(DataSource ds, Long pk)
     Load the deadlines for the activity with the given primary key from the given datasource.

This is provided as a static package visible method as it is used by WfActivityEJB as well.

public  MaplookForMessage(String channel)
     Looks for a message on the given channel and if found returns it.
protected  ExtActivityLocallookupActivityLocal(String key)
     Return an arbitrary activity with the given key.
public  WfProcessMgrmanager()
     Returns the process manager which created this process.
public  PrincipalprocessCreator()
     Return the Principal that created this process.
public  ProcessDefinitionDirectoryLocalprocessDefinitionDirectoryLocal()
     Return the process definition directory.
protected  voidremoveThis()
     Remove this process.
public  voidsetEntityContext(EntityContext context)
     Set the associated session context.
public  voidsetName(String newValue)
     Set a new name of the process.
protected  voidsetPaAuditEventSelection(int newValue)
     The setter method implementation for the persistent attribute auditEventSelection.
protected  voidsetPaDebug(boolean newDebug)
     The setter method implementation for the persistent attribute debug.
protected  voidsetPaDescription(String newDescription)
     The setter method implementation for the persistent attribute description.
protected  voidsetPaId(String newId)
     The setter method implementation for the persistent attribute id.
protected  voidsetPaLastStateTime(Date newLastStateTime)
     The setter method implementation for the persistent attribute lastStateTime.
protected  voidsetPaName(String newName)
     The setter method implementation for the persistent attribute name.
protected  voidsetPaPriority(Priority newPriority)
     The setter method implementation for the persistent attribute priority.
protected  voidsetPaProcessDef(ProcessDefinition newProcessDef)
     The setter method implementation for the persistent attribute processDef.
protected  voidsetPaProcessMgrName(String newProcessMgrName)
     The setter method implementation for the persistent attribute processMgrName.
protected  voidsetPaProcessMgrVersion(String newProcessMgrVersion)
     The setter method implementation for the persistent attribute processMgrVersion.
protected  voidsetPaStoreAuditEvents(boolean newValue)
     The setter method implementation for the persistent attribute storeAuditEvents.
protected  voidsetPaTypedState(State newTypedState)
     The setter method implementation for the persistent attribute typedState.
public  voidstart()
     Starts a process.
public  voidstartTimer(Date due, Serializable info)
     Start a timer that will call handleTimeout at the given date with the given info.
public  Collectionsteps()
     Returns a collection of activities of the process.
public  CollectionstepsLocal()
     Returns a collection of activities of the process.
public  voidstopTimers()
     Stop all timers that this object has created.
public  voidsubmitChannelMessage(String channel, Map message)
     Deliver a message on the given channel to a receiver tool listening on that channel.
public  ProcesstoProcess()
     Return the remote version of this object.
public  ExtProcessLocaltoProcessLocal()
    
public  voidtransitionUpdated(ExtTransitionLocal transition)
     Notify about the change of a transition.
public  Listtransitions()
     Gets a list of transitions for this process.
public  ListtransitionsLocal()
     Gets a list of transitions for this process.
public  voidunsetEntityContext()
     Unset the associated session context.
public static  voidupdateDeadlines(DataSource ds, Connection con, Long pk, Long ak, List dls, boolean doDelete)
     Updates the deadlines for the activity with the given primary key using the given connection.

This is provided as a static package visible method as it is used by WfActivityEJB as well.



Constructor Detail
WfProcessEJB
public WfProcessEJB()(Code)
Contructor.




Method Detail
activityByKey
public Activity activityByKey(String key) throws InvalidKeyException(Code)
Returns the Activity Activity with the given key. The OMG interface only defines a WfProcess.steps method for listing all the activities associated with the process. While, of course, one could select the activity with a certain key from that list, this would be rather insufficient.
Parameters:
  key - the de.danet.an.workflow.omgcore.WfActivity.key key of the process. the activity associated with the key.
throws:
  InvalidKeyException - if no activity with the given keyexists.



activityByKeyLocal
public ActivityLocal activityByKeyLocal(String key) throws InvalidKeyException(Code)
Returns the Activity ActivityLocal with the given key. The OMG interface only defines a WfProcess.steps method for listing all the activities associated with the process. While, of course, one could select the activity with a certain key from that list, this would be rather insufficient.
Parameters:
  key - the de.danet.an.workflow.omgcore.WfActivity.key key of the process. the activity associated with the key.
throws:
  InvalidKeyException - if no activity with the given keyexists.



activityRequesterInfo
protected WfAuditEvent activityRequesterInfo(WfRequester req)(Code)
Retrieve the base event information about a requesting activity.
Parameters:
  req - the requester. the base info using an audit event as DTO.



auditEventBase
public WfAuditEvent auditEventBase()(Code)
Returns an audit event object with process relevant information initialized. the process related information.



closeChannels
protected void closeChannels()(Code)
Closes all channels.



copyProcessDefinition
public void copyProcessDefinition(String procDefXpdl)(Code)
Copy the process definition in xpdl string in this process. If the process definition need to be removed, use this method to copy process definition in the database field of xpdl so that the process definition can still be reconstructed.
Parameters:
  procDefXpdl - the given process definition in xpdl string.



createActivity
protected de.danet.an.workflow.localcoreapi.WfActivityLocal createActivity(String blockActId, Priority priority, String name, String description, StartFinishMode startMode, StartFinishMode finishMode, JoinAndSplitMode joinMode, JoinAndSplitMode splitMode, Implementation[] implementation, String performer, List deadlines, boolean deferChoiceOnSplit, int auditEventSelection, boolean storeAuditEvents)(Code)
Factory method that create new persistent objects of type WfActivity. Must be implement by the persistence layer.
Parameters:
  blockActId - if the activity is part of a block activity,else null
Parameters:
  priority - a Priority value
Parameters:
  name - the activity's name
Parameters:
  description - activity description
Parameters:
  startMode - the start mode
Parameters:
  finishMode - the finish mode
Parameters:
  joinMode - the join mode
Parameters:
  splitMode - the split mode
Parameters:
  implementation - the implementation description
Parameters:
  performer - the performer
Parameters:
  deadlines - the deadlines
Parameters:
  deferChoiceOnSplit - if true, choice is to be deferred
Parameters:
  auditEventSelection - the audit event selection
Parameters:
  storeAuditEvents - if true, audit events are stored in thedatabase the created activity.



createActivityKey
protected Long createActivityKey()(Code)
Provide a new unique activity key. the key.



deliverChannelMessage
public boolean deliverChannelMessage(String channel, Map message) throws InvalidDataException(Code)
Deliver a message on the given channel to a receiver tool listening on that channel.
Parameters:
  channel - the channel name
Parameters:
  message - the message true if the mesage could be delivered,false if no activity was listening
throws:
  InvalidDataException - if the message contains invalid data



doCreateTransition
protected TransitionLocal doCreateTransition(String id, String group, int order, ActivityLocal fromAct, ActivityLocal toAct, int condType, String condition)(Code)
Create a new transition with given id, from-activity, to-activity.
Parameters:
  id - the transition id
Parameters:
  group - the transition group id
Parameters:
  order - the transition priority
Parameters:
  fromAct - the from Activity
Parameters:
  toAct - the to Activity
Parameters:
  condType - type of the condition
Parameters:
  condition - condition of this transition the created transition.



ejbActivate
public void ejbActivate() throws EJBException(Code)
The activate method is called when the instance is activated from its "passive" state. The instance should acquire any resource that it has released earlier in the ejbPassivate() method. This method gets the primary key from container.
See Also:   javax.ejb.EntityBean



ejbCreate
public Long ejbCreate(de.danet.an.workflow.api.ProcessDefinition procDef, WfRequester req) throws CreateException(Code)
Create an process and save it into database. It throws EJBException if any error occurs.
Parameters:
  procDef - process definition
Parameters:
  req - requester of the process Long primary key of the process
throws:
  CreateException - no



ejbFindAll
public Collection ejbFindAll() throws FinderException(Code)
This method looks up all processes. a Collection object with remote interface of WfProcess.
throws:
  FinderException - because of the EJB syntax.



ejbFindByActivityKey
public Long ejbFindByActivityKey(String key) throws FinderException(Code)
This method looks up a process by the key de.danet.an.workflow.omgcore.WfActivity.key key of one of its activities.
Parameters:
  key - the activity key. the process EJB (remote interface).
throws:
  FinderException - if no process found.



ejbFindByPrimaryKey
public Long ejbFindByPrimaryKey(Long primaryKey) throws FinderException(Code)
This method looks up a process EJB by its primary key (dbid).
Parameters:
  primaryKey - the process primary key. the process EJB (remote interface).
throws:
  FinderException - if no process found.



ejbFindByProcessKey
public Long ejbFindByProcessKey(String key) throws FinderException(Code)
This method looks up a process by its de.danet.an.workflow.omgcore.WfProcess.key key .
Parameters:
  key - the process key. the process EJB (remote interface).
throws:
  FinderException - if no process found.



ejbFindByProcessMgrName
public Collection ejbFindByProcessMgrName(String processMgrName) throws FinderException(Code)
This method looks up all the process by its process type.
Parameters:
  processMgrName - the process type. a Collection object with remote interface of WfProcess.
throws:
  FinderException - because of the EJB syntax.



ejbFindByProcessTypeAndDataItem
public Collection ejbFindByProcessTypeAndDataItem(String processMgr, String itemName, String itemValue) throws FinderException(Code)
Look up all processes of a given type that have a given value in a particular process data item. Note that this method may only be used for data items of type string.
Parameters:
  processMgr - the process type
Parameters:
  itemName - the name of the process data item
Parameters:
  itemValue - the value of the process data item a Collection object with remote interface of WfProcess.
throws:
  FinderException - because of the EJB syntax.



ejbFindByRequesterHash
public Collection ejbFindByRequesterHash(int hash) throws FinderException(Code)
This method looks up all processes that have a requester with the given hash value.
Parameters:
  hash - the hash value. a Collection object with remote interface of WfProcess.
throws:
  FinderException - because of the EJB syntax.



ejbFindWithoutDefinitionByProcessMgrName
public Collection ejbFindWithoutDefinitionByProcessMgrName(String processMgrName) throws FinderException(Code)
This method looks up all processes without a local copy of the process definition by their process type.
Parameters:
  processMgrName - the process type. a Collection object with remote interface of WfProcess.
throws:
  FinderException - because of the EJB syntax.



ejbLoad
public void ejbLoad() throws EJBException(Code)
A container invokes this method to synchronize the state of an enterprise bean instance with the entity object's state in the database.
See Also:   javax.ejb.EntityBean



ejbPassivate
public void ejbPassivate() throws EJBException(Code)
The passivate method is called before the instance enters the "passive" state. The instance should release any resources that it can re-acquire later in the ejbActivate() method.
See Also:   javax.ejb.EntityBean



ejbPostCreate
public void ejbPostCreate(ProcessDefinition procDef, WfRequester req) throws CreateException(Code)
Create an process and save it into database. First are created activities, transitions and transitions references.
Parameters:
  procDef - process definition
Parameters:
  req - requester of the process
throws:
  CreateException - if the process can not be created.



ejbRemove
public void ejbRemove() throws RemoveException(Code)
A container invokes this method before it ends the life of the session object. This happens as a result of a client's invoking a remove operation, or when a container decides to terminate the session object after a timeout.
throws:
  RemoveException - if the activity is not closed.
See Also:   javax.ejb.EntityBean



ejbStore
public void ejbStore() throws EJBException(Code)
A container invokes this method to synchronize the state of the entity object in the database with the state of the enterprise bean instancee.
See Also:   javax.ejb.EntityBean



ejbTimeout
public void ejbTimeout(Timer timer)(Code)
Handle the timeout of a timer.
Parameters:
  timer - the timer that has expired.



equals
public boolean equals(Object obj)(Code)
Indicates if some other object is equal to this one.

Note that obj must implement the process's remote interface. Comparing a domain object usually indicates some violation of the constraints of our implementation environment.
Parameters:
  obj - the object to compare with. true if the other object is equal.




fireAuditEvent
protected void fireAuditEvent(WfAuditEvent evt)(Code)
Process newly generated event.
Parameters:
  evt - Event



forwardAbandon
public void forwardAbandon(Activity activity, ExceptionResult result) throws TransitionNotAllowedException(Code)
Forward the state change to the given activity. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
Parameters:
  result - the exception data
throws:
  TransitionNotAllowedException - if the state change isnot possible



forwardAbort
public void forwardAbort(Activity activity) throws CannotStopException, NotRunningException(Code)
Forward the state change to the given activity. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
throws:
  CannotStopException - if the state change isnot possible
throws:
  NotRunningException - if the state change isnot possible



forwardActivityInfo
public Activity.Info forwardActivityInfo(Activity activity)(Code)
Forward the request for the activity info to the given activity. This method is used by ActivityProxy to first involve the process in the transaction (activity info includes the process' description). This avoids a lot of deadlocks.
Parameters:
  activity - the activity the activity info



forwardChoose
public boolean forwardChoose(Activity activity) throws TransitionNotAllowedException(Code)
Choose the given activity for further processing in deferred choice.
Parameters:
  activity - the activity true if the activity could be made theeffectively chosen one
throws:
  TransitionNotAllowedException - if the activity isneither running nor suspended



forwardComplete
public void forwardComplete(Activity activity) throws CannotCompleteException(Code)
Forward the state change to the given activity. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
throws:
  CannotCompleteException - if the state change isnot possible



forwardResult
public void forwardResult(Activity activity, ProcessData result) throws InvalidDataException(Code)
Forward the result to the given activity. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
Parameters:
  result - the result
throws:
  InvalidDataException - if the result cannot be set



forwardStateChange
public void forwardStateChange(Activity activity, State state) throws InvalidStateException, TransitionNotAllowedException(Code)
Forward the state change to the given activity calling changeState. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
Parameters:
  state - the state
throws:
  InvalidStateException - if the state change is notpossible
throws:
  TransitionNotAllowedException - if the state change isnot possible



forwardTerminate
public void forwardTerminate(Activity activity) throws CannotStopException, NotRunningException(Code)
Forward the state change to the given activity. This method is used by ActivityProxy to first involve the process in the transaction. This avoids a lot of deadlocks.
Parameters:
  activity - the activity
throws:
  CannotStopException - if the state change isnot possible
throws:
  NotRunningException - if the state change isnot possible



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



getPaBlockDeadlines
protected Map getPaBlockDeadlines()(Code)
The getter method implementation for the persistent attribute blockDeadlines. the value of blockDeadlines.



getPaCreateTime
protected Date getPaCreateTime()(Code)
The getter method implementation for the persistent attribute createTime. the value of createTime.



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



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



getPaId
protected String getPaId()(Code)
The getter method implementation for the persistent attribute id.
See Also:   WfProcessEJB.setPaId the value of process Id.



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



getPaLastStateTime
protected Date getPaLastStateTime()(Code)
The getter method implementation for the persistent attribute lastStateTime.
See Also:   WfProcessEJB.setPaLastStateTime the value of lastStateTime.



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



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



getPaProcessData
protected ProcessData getPaProcessData()(Code)
The getter method implementation for the persistent attribute processData. the value of processData.



getPaProcessDef
protected ProcessDefinition getPaProcessDef()(Code)
The getter method implementation for the persistent attribute processDef. Three fields in the database contribute to the persistence implementation for the process definition: PackageId, ProcessId and Xpdl. If the process definition for the process has not been changed specifically and if the process definition still exists in the process definition directory, then packageId and processId are used to lookup the process definition.

If the definition of the process has changed, e.g. by inserting an additional activity or the process definition has been removed from the process definition directory. the string in field xpdl is used to reconstruct a process definition.
See Also:   WfProcessEJB.setPaProcessDef the value of processDef.




getPaProcessMgrName
protected String getPaProcessMgrName()(Code)
The getter method implementation for the persistent attribute processMgrName.
See Also:   WfProcessEJB.setPaProcessMgrName the value of processMgrName.



getPaProcessMgrVersion
protected String getPaProcessMgrVersion()(Code)
The getter method implementation for the persistent attribute processMgrVersion.
See Also:   WfProcessEJB.setPaProcessMgrVersion the value of processMgrVersion.



getPaRequester
protected WfRequester getPaRequester()(Code)
The getter method implementation for the persistent attribute requester. the value of requester.



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



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



hashCode
public int hashCode()(Code)
Return the hash code.

the result.




history
public Collection history() throws HistoryNotAvailableException(Code)
Returns a collection of WfAuditEvents associated with this process describing its history. the collection of audit events
throws:
  HistoryNotAvailableException - in case the history is not available for any reason



loadDeadlines
static List loadDeadlines(DataSource ds, Long pk) throws SQLException, IOException(Code)
Load the deadlines for the activity with the given primary key from the given datasource.

This is provided as a static package visible method as it is used by WfActivityEJB as well. The deadline table is considered a shared resource. As a process and its activities operate on a distinct set of deadlines, there is no need for activities to access the deadlines via the process (and we can save the overhead).
Parameters:
  ds - the data source to use
Parameters:
  pk - the key of the activity the list of deadlines
throws:
  SQLException - if an error occurs
throws:
  IOException - if an error occurs




lookForMessage
public Map lookForMessage(String channel)(Code)
Looks for a message on the given channel and if found returns it.
Parameters:
  channel - the channel name the message or null



lookupActivityLocal
protected ExtActivityLocal lookupActivityLocal(String key) throws InvalidKeyException(Code)
Return an arbitrary activity with the given key. The activity need not belong to this process.
Parameters:
  key - activity key the activity
throws:
  InvalidKeyException - if the activity cannot be found



manager
public WfProcessMgr manager()(Code)
Returns the process manager which created this process. the associated process manager.



processCreator
public Principal processCreator()(Code)
Return the Principal that created this process. the principal.



processDefinitionDirectoryLocal
public ProcessDefinitionDirectoryLocal processDefinitionDirectoryLocal()(Code)
Return the process definition directory. While there is no immediate relation between a process instance and the known process definitions, the definitions nevertheless make up part of the environment of a process. Specifically, this method is needed to start a sub-process in an activity. the process definition directory



removeThis
protected void removeThis() throws CannotRemoveException(Code)
Remove this process.
throws:
  CannotRemoveException - if the process is still in progress



setEntityContext
public void setEntityContext(EntityContext context) throws EJBException(Code)
Set the associated session context. The container calls this method after the instance creation.
See Also:   javax.ejb.EntityBean
throws:
  EJBException - Throws on any error.
Parameters:
  context - - A SessionContext interface for the instance



setName
public void setName(String newValue)(Code)
Set a new name of the process. The change must be forwarded to the activity EJBs as they cache the name.
Parameters:
  newValue - new name.



setPaAuditEventSelection
protected void setPaAuditEventSelection(int newValue)(Code)
The setter method implementation for the persistent attribute auditEventSelection.
Parameters:
  newValue - the new value of auditEventSelection.
See Also:   WfProcessEJB.getPaAuditEventSelection



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



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



setPaId
protected void setPaId(String newId)(Code)
The setter method implementation for the persistent attribute id.
Parameters:
  newId - the new value of process Id.
See Also:   WfProcessEJB.getPaId



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



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



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



setPaProcessDef
protected void setPaProcessDef(ProcessDefinition newProcessDef)(Code)
The setter method implementation for the persistent attribute processDef.
Parameters:
  newProcessDef - the new value of processDef.
See Also:   WfProcessEJB.getPaProcessDef



setPaProcessMgrName
protected void setPaProcessMgrName(String newProcessMgrName)(Code)
The setter method implementation for the persistent attribute processMgrName.
Parameters:
  newProcessMgrName - the new value of processMgrName.
See Also:   WfProcessEJB.getPaProcessMgrName



setPaProcessMgrVersion
protected void setPaProcessMgrVersion(String newProcessMgrVersion)(Code)
The setter method implementation for the persistent attribute processMgrVersion.
Parameters:
  newProcessMgrVersion - the new value of processMgrVersion.
See Also:   WfProcessEJB.getPaProcessMgrVersion



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



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



start
public void start() throws CannotStartException, AlreadyRunningException(Code)
Starts a process.
throws:
  CannotStartException - when the process cannot be started (e.g.,because it is not properly initialized).
throws:
  AlreadyRunningException - when the process has already been started.



startTimer
public void startTimer(Date due, Serializable info)(Code)
Start a timer that will call handleTimeout at the given date with the given info.
Parameters:
  due - target date
Parameters:
  info - the context



steps
public Collection steps()(Code)
Returns a collection of activities of the process. collection of activities of the process



stepsLocal
public Collection stepsLocal()(Code)
Returns a collection of activities of the process. collection of activities of the process



stopTimers
public void stopTimers()(Code)
Stop all timers that this object has created.



submitChannelMessage
public void submitChannelMessage(String channel, Map message) throws InvalidDataException(Code)
Deliver a message on the given channel to a receiver tool listening on that channel. If no tool is listening, store the message.
Parameters:
  channel - the channel name
Parameters:
  message - the message
throws:
  InvalidDataException - if the message contains invalid data



toProcess
public Process toProcess()(Code)
Return the remote version of this object. This is the client side implementation of the remote interface (i.e. the EJB object). the remote stub.



toProcessLocal
public ExtProcessLocal toProcessLocal()(Code)



transitionUpdated
public void transitionUpdated(ExtTransitionLocal transition)(Code)
Notify about the change of a transition.
Parameters:
  transition - the changed transition



transitions
public List transitions()(Code)
Gets a list of transitions for this process. list of transitions for this process



transitionsLocal
public List transitionsLocal()(Code)
Gets a list of transitions for this process. The method is public, because the transition manager needs access to the transitions of a process. list of transitions for this process



unsetEntityContext
public void unsetEntityContext() throws EJBException(Code)
Unset the associated session context.
See Also:   javax.ejb.EntityBean



updateDeadlines
public static void updateDeadlines(DataSource ds, Connection con, Long pk, Long ak, List dls, boolean doDelete) throws SQLException, IOException(Code)
Updates the deadlines for the activity with the given primary key using the given connection.

This is provided as a static package visible method as it is used by WfActivityEJB as well. The deadline table is considered a shared resource. As a process and its activities operate on a distinct set of deadlines, there is no need for activities to access the deadlines via the process (and we can save the overhead).
Parameters:
  ds - the data source
Parameters:
  con - the connection to the database
Parameters:
  pk - the key of the process
Parameters:
  ak - the key of the activity
Parameters:
  dls - the list of deadlines
Parameters:
  doDelete - if old values should be deleted (should only beset to false if updating the deadlines for a newlycreated activity
throws:
  SQLException - if an error occurs
throws:
  IOException - if an error occurs




Methods inherited from de.danet.an.workflow.domain.AbstractProcess
public void abort() throws CannotStopException, NotRunningException(Code)(Java Doc)
public Collection activitiesInState(String state) throws InvalidStateException(Code)(Java Doc)
public Collection activitiesOfBlockActivity(String blockActivity)(Code)(Java Doc)
abstract public ActivityLocal activityByKeyLocal(String key) throws InvalidKeyException(Code)(Java Doc)
abstract protected WfAuditEvent activityRequesterInfo(WfRequester req)(Code)(Java Doc)
protected WfAuditEvent auditEventBase(String eventType)(Code)(Java Doc)
protected ActivityLocal blockActivityRepresentation(String key)(Code)(Java Doc)
public void changeState(State newState) throws InvalidStateException, TransitionNotAllowedException(Code)(Java Doc)
public boolean choose(ExtActivityLocal activity) throws TransitionNotAllowedException(Code)(Java Doc)
protected int cleanupMode()(Code)(Java Doc)
public void closeActivity(ExtActivityLocal activity, State closedState)(Code)(Java Doc)
protected void closeChannels()(Code)(Java Doc)
abstract protected WfActivityLocal createActivity(String blockActId, Priority priority, String name, String description, StartFinishMode startMode, StartFinishMode finishMode, JoinAndSplitMode joinMode, JoinAndSplitMode splitMode, Implementation[] implementation, String performer, List deadlines, boolean deferredChoice, int auditEventSelection, boolean storeAuditEvents)(Code)(Java Doc)
abstract protected Long createActivityKey()(Code)(Java Doc)
public Date createTime()(Code)(Java Doc)
protected void dispose()(Code)(Java Doc)
abstract protected TransitionLocal doCreateTransition(String id, String group, int order, ActivityLocal fromAct, ActivityLocal toAct, int condType, String condition)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public Serializable[] evalExpressions(Object[][] expressionData)(Code)(Java Doc)
public Serializable evalScript(String script) throws ScriptException(Code)(Java Doc)
abstract protected Map getPaBlockDeadlines()(Code)(Java Doc)
abstract protected Date getPaCreateTime()(Code)(Java Doc)
abstract protected String getPaId()(Code)(Java Doc)
abstract protected Priority getPaPriority()(Code)(Java Doc)
abstract protected ProcessData getPaProcessData()(Code)(Java Doc)
abstract protected ProcessDefinition getPaProcessDef()(Code)(Java Doc)
abstract protected String getPaProcessMgrName()(Code)(Java Doc)
abstract protected String getPaProcessMgrVersion()(Code)(Java Doc)
abstract protected WfRequester getPaRequester()(Code)(Java Doc)
protected Map getStateTransitionMap()(Code)(Java Doc)
protected void handleAbortedEvent(WfStateAuditEvent event)(Code)(Java Doc)
public void handleAuditEvent(WfAuditEvent event)(Code)(Java Doc)
protected void handleCompletedEvent(WfStateAuditEvent event)(Code)(Java Doc)
public void handleException(ExtActivityLocal activity, String exceptionName)(Code)(Java Doc)
protected void handleResumedEvent(WfStateAuditEvent event)(Code)(Java Doc)
protected void handleStartedEvent(WfStateAuditEvent event)(Code)(Java Doc)
protected void handleTerminatedEvent(WfStateAuditEvent event)(Code)(Java Doc)
public void handleTimeout(Serializable info)(Code)(Java Doc)
protected void init(ProcessDefinition procDef)(Code)(Java Doc)
public static boolean isHandled(WfAuditEvent event)(Code)(Java Doc)
public Scriptable jsScope()(Code)(Java Doc)
abstract protected ExtActivityLocal lookupActivityLocal(String key) throws InvalidKeyException(Code)(Java Doc)
public ProcessData processContext()(Code)(Java Doc)
public ProcessDefinition processDefinition()(Code)(Java Doc)
protected void refresh()(Code)(Java Doc)
abstract protected void removeThis() throws CannotRemoveException(Code)(Java Doc)
public WfRequester requester()(Code)(Java Doc)
public Process requestingProcess()(Code)(Java Doc)
public ProcessData result() throws ResultNotAvailableException(Code)(Java Doc)
public void setDebugEnabled(boolean debug) throws InvalidStateException(Code)(Java Doc)
abstract protected void setPaId(String newId)(Code)(Java Doc)
abstract protected void setPaPriority(Priority newPriority)(Code)(Java Doc)
abstract protected void setPaProcessDef(ProcessDefinition newProcessDef)(Code)(Java Doc)
abstract protected void setPaProcessMgrName(String newProcessMgrName)(Code)(Java Doc)
abstract protected void setPaProcessMgrVersion(String newProcessMgrVersion)(Code)(Java Doc)
public void setProcessContext(ProcessData newValues) throws InvalidDataException, UpdateNotAllowedException(Code)(Java Doc)
public void setRequester(WfRequester requester) throws CannotChangeRequesterException(Code)(Java Doc)
public void start() throws CannotStartException, AlreadyRunningException(Code)(Java Doc)
public Collection steps()(Code)(Java Doc)
abstract public Collection stepsLocal()(Code)(Java Doc)
public void terminate() throws CannotStopException, NotRunningException(Code)(Java Doc)
abstract public Process toProcess()(Code)(Java Doc)
abstract public ExtProcessLocal toProcessLocal()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
protected TransitionManager transitionManager()(Code)(Java Doc)
abstract public List transitionsLocal()(Code)(Java Doc)
public WfRequester unresolvedRequester()(Code)(Java Doc)

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