001: /*
002: * Generated by XDoclet - Do not edit!
003: */
004: package org.obe.client.api.base;
005:
006: import org.obe.client.api.tool.Parameter;
007: import org.obe.client.api.tool.ToolInvocation;
008: import org.obe.xpdl.model.pkg.XPDLPackage;
009: import org.wfmc.audit.WMAAuditEntry;
010: import org.wfmc.wapi.*;
011:
012: /**
013: * Generic interface to the workflow engine. The methods in this interface all
014: * throw java.lang.Exception in order to support J2EE local/remote transparency.
015: */
016: public interface WorkflowEngineIntf {
017: WMProcessDefinition[] listProcessDefinitions(WMFilter filter,
018: boolean countFlag) throws Exception;
019:
020: WMProcessDefinitionState[] listProcessDefinitionStates(
021: WMFilter filter, boolean countFlag) throws Exception;
022:
023: void changeProcessDefinitionState(String processDefinitionId,
024: WMProcessDefinitionState newState) throws Exception;
025:
026: String createProcessInstance(String processDefinitionId,
027: String processInstanceName) throws Exception;
028:
029: String createProcessInstanceVersioned(String name,
030: String processInstanceName) throws Exception;
031:
032: String startProcess(String processInstanceId) throws Exception;
033:
034: void terminateProcessInstance(String processInstanceId)
035: throws Exception;
036:
037: void changeProcessInstanceState(String processInstanceId,
038: WMProcessInstanceState newState) throws Exception;
039:
040: WMProcessInstanceState[] listProcessInstanceStates(
041: String processInstanceId, WMFilter filter, boolean countFlag)
042: throws Exception;
043:
044: WMAttribute[] listProcessInstanceAttributes(
045: String processInstanceId, WMFilter filter, boolean countFlag)
046: throws Exception;
047:
048: WMAttribute getProcessInstanceAttributeValue(
049: String processInstanceId, String attributeName)
050: throws Exception;
051:
052: void assignProcessInstanceAttribute(String processInstanceId,
053: String attributeName, Object attributeValue)
054: throws Exception;
055:
056: WMActivityInstanceState[] listActivityInstanceStates(
057: String processInstanceId, String activityInstanceId,
058: WMFilter filter, boolean countFlag) throws Exception;
059:
060: void changeActivityInstanceState(String processInstanceId,
061: String activityInstanceId, WMActivityInstanceState newState)
062: throws Exception;
063:
064: WMAttribute[] listActivityInstanceAttributes(
065: String processInstanceId, String activityInstanceId,
066: WMFilter filter, boolean countFlag) throws Exception;
067:
068: WMAttribute getActivityInstanceAttributeValue(
069: String processInstanceId, String activityInstanceId,
070: String attributeName) throws Exception;
071:
072: void assignActivityInstanceAttribute(String processInstanceId,
073: String activityInstanceId, String attributeName,
074: Object attributeValue) throws Exception;
075:
076: WMProcessInstance[] listProcessInstances(WMFilter filter,
077: boolean countFlag) throws Exception;
078:
079: WMProcessInstance getProcessInstance(String processInstanceId)
080: throws Exception;
081:
082: WMActivityInstance[] listActivityInstances(WMFilter filter,
083: boolean countFlag) throws Exception;
084:
085: WMActivityInstance getActivityInstance(String processInstanceId,
086: String activityInstanceId) throws Exception;
087:
088: WMWorkItem[] listWorkItems(WMFilter filter, boolean countFlag)
089: throws Exception;
090:
091: WMWorkItem getWorkItem(String processInstanceId, String workItemId)
092: throws Exception;
093:
094: void completeWorkItem(String processInstanceId, String workItemId)
095: throws Exception;
096:
097: void reassignWorkItem(String sourceUser, String targetUser,
098: String processInstanceId, String workItemId)
099: throws Exception;
100:
101: WMWorkItemState[] listWorkItemStates(String processInstanceId,
102: String workItemId, WMFilter filter, boolean countFlag)
103: throws Exception;
104:
105: void changeWorkItemState(String processInstanceId,
106: String workItemId, WMWorkItemState newState)
107: throws Exception;
108:
109: WMAttribute[] listWorkItemAttributes(String processInstanceId,
110: String workItemId, WMFilter filter, boolean countFlag)
111: throws Exception;
112:
113: WMAttribute getWorkItemAttributeValue(String processInstanceId,
114: String workItemId, String attributeName) throws Exception;
115:
116: void assignWorkItemAttribute(String processInstanceId,
117: String workItemId, String attributeName,
118: Object attributeValue) throws Exception;
119:
120: void changeProcessInstancesState(String processDefinitionId,
121: WMFilter filter, WMProcessInstanceState newState)
122: throws Exception;
123:
124: void changeActivityInstancesState(String processDefinitionId,
125: String activityDefinitionId, WMFilter filter,
126: WMActivityInstanceState newState) throws Exception;
127:
128: void terminateProcessInstances(String processDefinitionId,
129: WMFilter filter) throws Exception;
130:
131: void assignProcessInstancesAttribute(String processDefinitionId,
132: WMFilter filter, String attributeName, Object attributeValue)
133: throws Exception;
134:
135: void assignActivityInstancesAttribute(String processDefinitionId,
136: String activityDefinitionId, WMFilter filter,
137: String attributeName, Object attributeValue)
138: throws Exception;
139:
140: void abortProcessInstances(String processDefinitionId,
141: WMFilter filter) throws Exception;
142:
143: void abortProcessInstance(String processInstanceId)
144: throws Exception;
145:
146: String createPackage(XPDLPackage pkg) throws Exception;
147:
148: void updatePackage(XPDLPackage pkg) throws Exception;
149:
150: XPDLPackage getPackage(String packageId) throws Exception;
151:
152: String createPackage(String content, String contentType)
153: throws Exception;
154:
155: String getPackageContent(String packageId, String contentType)
156: throws Exception;
157:
158: void setPackageContent(String packageId, String content,
159: String contentType) throws Exception;
160:
161: void deletePackage(String packageId) throws Exception;
162:
163: void deleteProcessInstance(String processInstanceId)
164: throws Exception;
165:
166: void deleteProcessInstances(String processDefinitionId,
167: WMFilter filter) throws Exception;
168:
169: WMAAuditEntry[] listAuditEntries(WMFilter filter) throws Exception;
170:
171: int deleteAuditEntries(WMFilter filter) throws Exception;
172:
173: ToolInvocation[] executeWorkItem(String processInstanceId,
174: String workItemId) throws Exception;
175:
176: void toolStarted(String processInstanceId, String workItemId)
177: throws Exception;
178:
179: void toolFinished(String processInstanceId, String workItemId,
180: int appStatus, Parameter[] parms) throws Exception;
181: }
|