Java Doc for WfExecutionObject.java in » ERP-CRM-Financial » SourceTap-CRM » org » ofbiz » 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

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 » ERP CRM Financial » SourceTap CRM » org.ofbiz.workflow

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.ofbiz.workflow .WfExecutionObject

All known Subclasses:   org.ofbiz.workflow.impl .WfExecutionObjectImpl,
WfExecutionObject
public interface WfExecutionObject (Code)
WfExecutionObject - Workflow Execution Object Interface
author:
   Andy Zeneski
version:
   $Revision: 1.2 $
since:
   2.0

Method Summary
public void abort()
     Abort the execution of this process or activity.
public void changeState(String newState)
     Set new state for this process or activity.
public String contextKey()

public String description()
     Getter for attribute 'description'.
throws:
  WfException - General workflow exception.
public GenericValue getDefinitionObject()
     Gets the GenericValue object of the definition.
public GenericDelegator getDelegator()

public Iterator getIteratorHistory(String query, java.util.Map namesInQuery)
     Search in the history for specific elements.
public GenericValue getRuntimeObject()
     Gets the GenericValue object of the runtime workeffort.
public List getSequenceHistory(int maxNumber)
     Getter for history sequence.
public List howClosedType()

throws:
  WfException - General workflow exception.
public int howManyHistory()
     Getter for history count.
public boolean isMemberOfHistory(WfExecutionObject member)
     Predicate to check if a 'member' is an element of the history.
Parameters:
  member - An element of the history.
throws:
  WfException - General workflow exception.
public String key()
     Getter for definition key
throws:
  WfException - General workflow exception.
public Timestamp lastStateTime()
     Getter for timestamp of last state change.
throws:
  WfException - General workflow exception.
public String name()
     Getter for attribute 'name'.
throws:
  WfException - General workflow exception.
public long priority()
     Getter for attribute 'priority'.
throws:
  WfException - General workflow exception.
public Map processContext()
     Getter for attribute 'context'.
throws:
  WfException - General workflow exception.
public void resume()
     Resume this process or activity.
public String runtimeKey()

public void setDescription(String newValue)
     Setter for attribute 'description'.
public void setName(String newValue)

public void setPriority(long newValue)
     Setter for attribute 'priority'.
public void setProcessContext(Map newValue)

public void setProcessContext(String newValue)

public String state()
     Retrieve the current state of this process or activity.
public void suspend()
     Suspend this process or activity.
public void terminate()
     Terminate this process or activity.
public List validStates()
     Retrieve the list of all valid states.
throws:
  WfException - General workflow exception.
public List whileOpenType()

public List whyNotRunningType()

throws:
  WfException - General workflow exception.
public List workflowStateType()

throws:
  WfException - General workflow exception.

Method Detail
abort
public void abort() throws WfException, CannotStop, NotRunning(Code)
Abort the execution of this process or activity.
throws:
  WfException - General workflow exception.
throws:
  CannotStop - The execution cannot be sopped.
throws:
  NotRunning - The process or activity is not yet running.

changeState
public void changeState(String newState) throws WfException, InvalidState, TransitionNotAllowed(Code)
Set new state for this process or activity.
Parameters:
  newState - New state to be set.
throws:
  WfException - General workflow exception.
throws:
  InvalidState - The state is invalid.
throws:
  TransitionNotAllowed - The transition is not allowed.

contextKey
public String contextKey() throws WfException(Code)
Get the Runtime Data key (context) String primary key for the runtime (context) data
throws:
  WfException -

description
public String description() throws WfException(Code)
Getter for attribute 'description'.
throws:
  WfException - General workflow exception. Description of this object.

getDefinitionObject
public GenericValue getDefinitionObject() throws WfException(Code)
Gets the GenericValue object of the definition.
throws:
  WfException -

getDelegator
public GenericDelegator getDelegator() throws WfException(Code)
Returns the delegator being used by this workflow GenericDelegator used for this workflow
throws:
  WfException -

getIteratorHistory
public Iterator getIteratorHistory(String query, java.util.Map namesInQuery) throws WfException, HistoryNotAvailable(Code)
Search in the history for specific elements.
Parameters:
  query - Search criteria.
Parameters:
  namesInQuery - elements to search.
throws:
  WfException - General workflow exception
throws:
  HistoryNotAvailable - Found history elements that meet the search criteria.

getRuntimeObject
public GenericValue getRuntimeObject() throws WfException(Code)
Gets the GenericValue object of the runtime workeffort.
throws:
  WfException -

getSequenceHistory
public List getSequenceHistory(int maxNumber) throws WfException, HistoryNotAvailable(Code)
Getter for history sequence.
Parameters:
  maxNumber - Maximum number of element in result list.
throws:
  WfException - General workflow exception.
throws:
  HistoryNotAvailable - List of History objects.

howClosedType
public List howClosedType() throws WfException(Code)

throws:
  WfException - General workflow exception. Termination art of this process ot activity.

howManyHistory
public int howManyHistory() throws WfException, HistoryNotAvailable(Code)
Getter for history count.
throws:
  WfException - Generall workflow exception
throws:
  HistoryNotAvailable - History can not be retrieved Count of history Elements

isMemberOfHistory
public boolean isMemberOfHistory(WfExecutionObject member) throws WfException(Code)
Predicate to check if a 'member' is an element of the history.
Parameters:
  member - An element of the history.
throws:
  WfException - General workflow exception. true if the element of the history, false otherwise.

key
public String key() throws WfException(Code)
Getter for definition key
throws:
  WfException - General workflow exception. Key of the definition object.

lastStateTime
public Timestamp lastStateTime() throws WfException(Code)
Getter for timestamp of last state change.
throws:
  WfException - General workflow exception. Timestamp of last state change.

name
public String name() throws WfException(Code)
Getter for attribute 'name'.
throws:
  WfException - General workflow exception. Name of the object.

priority
public long priority() throws WfException(Code)
Getter for attribute 'priority'.
throws:
  WfException - General workflow exception. Getter Priority of

processContext
public Map processContext() throws WfException(Code)
Getter for attribute 'context'.
throws:
  WfException - General workflow exception. Process context.

resume
public void resume() throws WfException, CannotResume, NotRunning, NotSuspended(Code)
Resume this process or activity.
throws:
  WfException - General workflow exception.
throws:
  CannotResume -
throws:
  NotRunning -
throws:
  NotSuspended -

runtimeKey
public String runtimeKey() throws WfException(Code)
Getter for the runtime key
throws:
  WfException - Key of the runtime object

setDescription
public void setDescription(String newValue) throws WfException(Code)
Setter for attribute 'description'.
Parameters:
  newValue - New value for attribute 'description'.
throws:
  WfException - General workflow exception.

setName
public void setName(String newValue) throws WfException(Code)
Setter for attribute 'name'
Parameters:
  newValue - Set the name of the object.
throws:
  WfException - General workflow exception.

setPriority
public void setPriority(long newValue) throws WfException(Code)
Setter for attribute 'priority'.
Parameters:
  newValue -
throws:
  WfException - General workflow exception

setProcessContext
public void setProcessContext(Map newValue) throws WfException, InvalidData, UpdateNotAllowed(Code)
Set the process context
Parameters:
  newValue - Set new process data.
throws:
  WfException - General workflow exception.
throws:
  InvalidData - The data is invalid.
throws:
  UpdateNotAllowed - Update the context is not allowed.

setProcessContext
public void setProcessContext(String newValue) throws WfException, InvalidData, UpdateNotAllowed(Code)
Set the process context (with previously stored data)
Parameters:
  newValue - RuntimeData entity key.
throws:
  WfException - General workflow exception.
throws:
  InvalidData - The data is invalid.
throws:
  UpdateNotAllowed - Update the context is not allowed.

state
public String state() throws WfException(Code)
Retrieve the current state of this process or activity.
throws:
  WfException - General workflow exception Current state.

suspend
public void suspend() throws WfException, CannotSuspend, NotRunning, AlreadySuspended(Code)
Suspend this process or activity.
throws:
  WfException - General workflow exception.
throws:
  CannotSuspend -
throws:
  NotRunning -
throws:
  AlreadySuspended -

terminate
public void terminate() throws WfException, CannotStop, NotRunning(Code)
Terminate this process or activity.
throws:
  WfException - General workflow exception
throws:
  CannotStop -
throws:
  NotRunning -

validStates
public List validStates() throws WfException(Code)
Retrieve the list of all valid states.
throws:
  WfException - General workflow exception. List of valid states.

whileOpenType
public List whileOpenType() throws WfException(Code)

throws:
  WfException - General workflow exception.

whyNotRunningType
public List whyNotRunningType() throws WfException(Code)

throws:
  WfException - General workflow exception. Reason for not running.

workflowStateType
public List workflowStateType() throws WfException(Code)

throws:
  WfException - General workflow exception. Current state of this object.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.