Java Doc for InstanceRepository.java in » Workflow-Engines » obe-1.0 » org » obe » spi » service » 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 » obe 1.0 » org.obe.spi.service

Source Cross Reference Class Diagram Java Document (Java Doc)

org.obe.spi.service .InstanceRepository

All known Subclasses:   org.obe.engine.persistence.memory .BasicInstanceRepository,  org.obe.server.j2ee.repository .EJBInstanceRepository,
InstanceRepository
public interface InstanceRepository extends WorkflowService(Code)
Provides transactional caching and persistence services for process instances. This includes process instances, workflow relevant data, activity instances, work items; also attributes for process instance, activity instance, and work items.
author:
   Adrian Price

Field Summary
String SERVICE_NAME


Method Summary
ActivityInstance createActivityInstance(String processDefinitionId, String processInstanceId, String activityDefinitionId, String activityName, JoinInstance join, String blockActivityInstanceId, PersistentIterator blockActivityIterator, int priority, int state, String[] participants)
     Returns the specified activity instance.
Parameters:
  processDefinitionId - The process definition id.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityDefinitionId - The activity definition id.
Parameters:
  activityName - The name of the activity.
Parameters:
  join - The activity's join (can be null).
Parameters:
  blockActivityInstanceId - The block activity instance ID, ornull if the activity is not defined within an activity set.
Parameters:
  blockActivityIterator - An iterator for the block activity owned bythe instance (can be null).
Parameters:
  priority - Activity priority.
Parameters:
  state - Activity state, one of the integer values defined inWMActivityInstanceState.
Parameters:
  participants - The list of participants for this activity.
AttributeInstance createActivityInstanceAttribute(String processInstanceId, String activityInstanceId, String attributeName, int attributeType, Object attributeValue)
     Creates an activity instance attribute.
ProcessInstance createProcessInstance(String processDefinitionId, String parentActivityInstanceId, String processInstanceName, int priority, int state, Date createdDate, Date startedDate, String[] participants)
     Creates a new process instance for the given process definition.
Parameters:
  processDefinitionId - The process definition ID.
Parameters:
  parentActivityInstanceId - The ID of the parent activity instance,if any.
Parameters:
  processInstanceName - The name of the process instance.
Parameters:
  priority - Process instance priority.
Parameters:
  state - The instance state, one of the integer values defined inWMProcessInstanceState.
Parameters:
  createdDate - The creation date/time of the instance.
Parameters:
  startedDate - The 'started' date/time for the instance.
AttributeInstance createProcessInstanceAttribute(String processInstanceId, String attributeName, int attributeType, Object attributeValue)
     Creates a process instance attribute.
WorkItem createWorkItem(String processDefinitionId, String processInstanceId, String activityInstanceId, int toolIndex, int state, String performer, String participant)
     Creates a work item.
Parameters:
  processDefinitionId - The process definition id.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityInstanceId - The activity instance id.
Parameters:
  toolIndex - The ID of the associated tool.
Parameters:
  state - The work item state, one of the integer values defined inWMWorkItemState.
Parameters:
  participant - The name of the participant to whom the work item isassigned.
AttributeInstance createWorkItemAttribute(String processInstanceId, String workItemId, String attributeName, int attributeType, Object attributeValue)
     Creates a work item attribute.
int deleteAuditEntries(WMFilter filter)
     Deletes the audit entries matching user specified criteria.
Parameters:
  filter - Filter criteria.
void deleteProcessInstance(String processInstanceId)
     Permanently deletes the specified process instance.
ActivityInstance findActivityInstance(String activityInstanceId)
     Reads the specified activity instance.
Parameters:
  activityInstanceId - The activity instance id.
ActivityInstance findActivityInstance(String processInstanceId, String activityDefinitionId, String blockActivityInstanceId)
     Reads the specified activity instance.
AttributeInstance findActivityInstanceAttribute(String processInstanceId, String activityInstanceId, String attributeName)
     Reads the specified activity attribute value.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityInstanceId - The activity instance id.
Parameters:
  attributeName - The attribute name.
AttributeInstance[] findActivityInstanceAttributes(String processDefinitionId, String processInstanceId, String activityDefinitionId, String activityInstanceId, WMFilter filter, String attributeName, boolean countFlag)
     Reads a set of activity instance attributes.
Parameters:
  processInstanceId - The ID of the process instance.
Parameters:
  activityInstanceId - The ID of the activity instance.
Parameters:
  filter - A Filter specification.
ActivityInstance[] findActivityInstances(String processDefinitionId, String activityDefinitionId, WMFilter filter, boolean countFlag)
     Reads a list of activity instances.
Parameters:
  processDefinitionId - The process definition ID, can benull.
Parameters:
  filter - A Filter specification.
WMAAuditEntry[] findAuditEntries(WMFilter filter)
     Finds the audit entries matching user specified criteria.
Parameters:
  filter - Filter criteria.
ProcessInstance findProcessInstance(String processInstanceId)
     Gets the specified process instance.
AttributeInstance findProcessInstanceAttribute(String processInstanceId, String attributeName)
     Reads the specified process attribute value.
AttributeInstance[] findProcessInstanceAttributes(String processDefinitionId, String processInstanceId, WMFilter filter, String attrName, boolean countFlag)
     Reads a list of process instance attributes.
ProcessInstance[] findProcessInstances(String processDefinitionId, WMFilter filter, boolean countFlag)
     Retrieves a list of process instances.
Parameters:
  processDefinitionId - The process definition Id, can benull>/code> to select from instances of any process definition. Parameters:   filter - A Filter specification.
WorkItem findWorkItem(String processInstanceId, String workItemId)
     Reads the specified work item.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  workItemId - The work item id.
AttributeInstance findWorkItemAttribute(String processInstanceId, String workItemId, String attributeName)
     Reads the specified work item attribute value.
AttributeInstance[] findWorkItemAttributes(String processInstanceId, String workItemId, WMFilter filter, boolean countFlag)
     Reads a set of work item attributes.
Parameters:
  filter - A Filter specification.
WorkItem[] findWorkItems(WMFilter filter, boolean countFlag)
     Reads a set of work items.
Parameters:
  filter - A Filter specification.
void purge()
     Purges all data from the instance repository.

Field Detail
SERVICE_NAME
String SERVICE_NAME(Code)

Method Detail
createActivityInstance
ActivityInstance createActivityInstance(String processDefinitionId, String processInstanceId, String activityDefinitionId, String activityName, JoinInstance join, String blockActivityInstanceId, PersistentIterator blockActivityIterator, int priority, int state, String[] participants) throws RepositoryException(Code)
Returns the specified activity instance.
Parameters:
  processDefinitionId - The process definition id.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityDefinitionId - The activity definition id.
Parameters:
  activityName - The name of the activity.
Parameters:
  join - The activity's join (can be null).
Parameters:
  blockActivityInstanceId - The block activity instance ID, ornull if the activity is not defined within an activity set.
Parameters:
  blockActivityIterator - An iterator for the block activity owned bythe instance (can be null).
Parameters:
  priority - Activity priority.
Parameters:
  state - Activity state, one of the integer values defined inWMActivityInstanceState.
Parameters:
  participants - The list of participants for this activity. The new activity instance.
throws:
  RepositoryException - Workflow client exception.

createActivityInstanceAttribute
AttributeInstance createActivityInstanceAttribute(String processInstanceId, String activityInstanceId, String attributeName, int attributeType, Object attributeValue) throws RepositoryException(Code)
Creates an activity instance attribute.
Parameters:
  processInstanceId - The process instance id
Parameters:
  activityInstanceId - The activity instance id
Parameters:
  attributeName - The attribute name
Parameters:
  attributeType - The attribute type
Parameters:
  attributeValue - The attribute value
throws:
  RepositoryException - Workflow client exception

createProcessInstance
ProcessInstance createProcessInstance(String processDefinitionId, String parentActivityInstanceId, String processInstanceName, int priority, int state, Date createdDate, Date startedDate, String[] participants) throws RepositoryException(Code)
Creates a new process instance for the given process definition.
Parameters:
  processDefinitionId - The process definition ID.
Parameters:
  parentActivityInstanceId - The ID of the parent activity instance,if any.
Parameters:
  processInstanceName - The name of the process instance.
Parameters:
  priority - Process instance priority.
Parameters:
  state - The instance state, one of the integer values defined inWMProcessInstanceState.
Parameters:
  createdDate - The creation date/time of the instance.
Parameters:
  startedDate - The 'started' date/time for the instance. Should benull unless the state parameter isWMProcessInstanceState.OPEN_RUNNING.
Parameters:
  participants - The list of process participants. The new process instance.
throws:
  RepositoryException - Workflow client exception.

createProcessInstanceAttribute
AttributeInstance createProcessInstanceAttribute(String processInstanceId, String attributeName, int attributeType, Object attributeValue) throws RepositoryException(Code)
Creates a process instance attribute.
Parameters:
  processInstanceId - The process instance id
Parameters:
  attributeName - The attribute name
Parameters:
  attributeType - The attribute type
Parameters:
  attributeValue - The attribute value
throws:
  RepositoryException - Workflow client exception

createWorkItem
WorkItem createWorkItem(String processDefinitionId, String processInstanceId, String activityInstanceId, int toolIndex, int state, String performer, String participant) throws RepositoryException(Code)
Creates a work item.
Parameters:
  processDefinitionId - The process definition id.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityInstanceId - The activity instance id.
Parameters:
  toolIndex - The ID of the associated tool.
Parameters:
  state - The work item state, one of the integer values defined inWMWorkItemState.
Parameters:
  participant - The name of the participant to whom the work item isassigned. The new work item.
throws:
  RepositoryException -

createWorkItemAttribute
AttributeInstance createWorkItemAttribute(String processInstanceId, String workItemId, String attributeName, int attributeType, Object attributeValue) throws RepositoryException(Code)
Creates a work item attribute.
Parameters:
  processInstanceId - The process instance id
Parameters:
  workItemId - The work item id
Parameters:
  attributeName - The attribute name
Parameters:
  attributeType - The attribute type
Parameters:
  attributeValue - The attribute value
throws:
  RepositoryException - Workflow client exception

deleteAuditEntries
int deleteAuditEntries(WMFilter filter) throws RepositoryException(Code)
Deletes the audit entries matching user specified criteria.
Parameters:
  filter - Filter criteria. Count of audit entries deleted.
throws:
  RepositoryException - If the filter type is unsupported.

deleteProcessInstance
void deleteProcessInstance(String processInstanceId) throws RepositoryException(Code)
Permanently deletes the specified process instance. Implementations must cascade this delete to include all related ActivityInstance, WorkItem and AttributeInstance entities.
Parameters:
  processInstanceId - The ID of the process instance to delete.
throws:
  RepositoryException -

findActivityInstance
ActivityInstance findActivityInstance(String activityInstanceId) throws RepositoryException(Code)
Reads the specified activity instance.
Parameters:
  activityInstanceId - The activity instance id. The activity instance.
throws:
  RepositoryException - Workflow client exception.

findActivityInstance
ActivityInstance findActivityInstance(String processInstanceId, String activityDefinitionId, String blockActivityInstanceId) throws RepositoryException(Code)
Reads the specified activity instance. This method takes either the activity definition ID or the activity instance ID.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityDefinitionId - The activity definition id.
Parameters:
  blockActivityInstanceId - The ID of the block activity instance towhich the activity instance belongs. The activity instance.
throws:
  RepositoryException - Workflow client exception.

findActivityInstanceAttribute
AttributeInstance findActivityInstanceAttribute(String processInstanceId, String activityInstanceId, String attributeName) throws RepositoryException(Code)
Reads the specified activity attribute value.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  activityInstanceId - The activity instance id.
Parameters:
  attributeName - The attribute name. The attribute.
throws:
  RepositoryException - Workflow client exception.

findActivityInstanceAttributes
AttributeInstance[] findActivityInstanceAttributes(String processDefinitionId, String processInstanceId, String activityDefinitionId, String activityInstanceId, WMFilter filter, String attributeName, boolean countFlag) throws RepositoryException(Code)
Reads a set of activity instance attributes.
Parameters:
  processInstanceId - The ID of the process instance.
Parameters:
  activityInstanceId - The ID of the activity instance.
Parameters:
  filter - A Filter specification. An array of matching activity instance attributes.

findActivityInstances
ActivityInstance[] findActivityInstances(String processDefinitionId, String activityDefinitionId, WMFilter filter, boolean countFlag) throws RepositoryException(Code)
Reads a list of activity instances.
Parameters:
  processDefinitionId - The process definition ID, can benull.
Parameters:
  filter - A Filter specification. An array of matching activity instances.

findAuditEntries
WMAAuditEntry[] findAuditEntries(WMFilter filter) throws RepositoryException(Code)
Finds the audit entries matching user specified criteria.
Parameters:
  filter - Filter criteria. Matching audit entries.
throws:
  RepositoryException - If the filter type is unsupported.

findProcessInstance
ProcessInstance findProcessInstance(String processInstanceId) throws RepositoryException(Code)
Gets the specified process instance.
Parameters:
  processInstanceId - The process instance id The process instance
throws:
  RepositoryException - Workflow client exception

findProcessInstanceAttribute
AttributeInstance findProcessInstanceAttribute(String processInstanceId, String attributeName) throws RepositoryException(Code)
Reads the specified process attribute value.
Parameters:
  processInstanceId - The process instance id
Parameters:
  attributeName - The attribute name The attribute
throws:
  RepositoryException - Workflow client exception

findProcessInstanceAttributes
AttributeInstance[] findProcessInstanceAttributes(String processDefinitionId, String processInstanceId, WMFilter filter, String attrName, boolean countFlag) throws RepositoryException(Code)
Reads a list of process instance attributes.
Parameters:
  processDefinitionId - The process definition id, can benull.
Parameters:
  processInstanceId - The process instance id, can benull.
Parameters:
  filter - The filter, can be null.
Parameters:
  attrName - The attribute name, can be null.
Parameters:
  countFlag - True to return count value The query handle
throws:
  RepositoryException - Workflow client exception

findProcessInstances
ProcessInstance[] findProcessInstances(String processDefinitionId, WMFilter filter, boolean countFlag) throws RepositoryException(Code)
Retrieves a list of process instances.
Parameters:
  processDefinitionId - The process definition Id, can benull>/code> to select from instances of any process definition. Parameters:   filter - A Filter specification. An array of matching process instances.

findWorkItem
WorkItem findWorkItem(String processInstanceId, String workItemId) throws RepositoryException(Code)
Reads the specified work item.
Parameters:
  processInstanceId - The process instance id.
Parameters:
  workItemId - The work item id. The work item.
throws:
  RepositoryException - Workflow client exception

findWorkItemAttribute
AttributeInstance findWorkItemAttribute(String processInstanceId, String workItemId, String attributeName) throws RepositoryException(Code)
Reads the specified work item attribute value.
Parameters:
  processInstanceId - The process instance id
Parameters:
  workItemId - The work item id
Parameters:
  attributeName - The attribute name The attribute
throws:
  RepositoryException - Workflow client exception

findWorkItemAttributes
AttributeInstance[] findWorkItemAttributes(String processInstanceId, String workItemId, WMFilter filter, boolean countFlag) throws RepositoryException(Code)
Reads a set of work item attributes.
Parameters:
  filter - A Filter specification. An array of matching work item attributes.
throws:
  RepositoryException - Workflow client exception

findWorkItems
WorkItem[] findWorkItems(WMFilter filter, boolean countFlag) throws RepositoryException(Code)
Reads a set of work items.
Parameters:
  filter - A Filter specification. An array of matching work items.

purge
void purge() throws RepositoryException(Code)
Purges all data from the instance repository. WARNING! All process instances, workflow relevant data, activity instances and work items will be permanently deleted.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.