001: /*
002: *
003: * Copyright (c) 2002 Adrian Price. All rights reserved.
004: */
005:
006: package org.wfmc.wapi2;
007:
008: import org.wfmc.wapi.*;
009:
010: /**
011: * Additional functions described in WfMC-TC-1009 Version 2.0e (Beta).
012: *
013: * @author Adrian Price
014: */
015: public interface WAPI2 extends WAPI {
016: boolean isWorkListHandlerProfileSupported();
017:
018: boolean isProcessControlStatusProfileSupported();
019:
020: boolean isProcessDefinitionProfileSupported();
021:
022: boolean isProcessAdminProfileSupported();
023:
024: boolean isActivityControlStatusProfileSupported();
025:
026: boolean isActivityAdminProfileSupported();
027:
028: boolean isEntityHandlerProfileSupported();
029:
030: boolean isAuditRecordProfileSupported();
031:
032: boolean isToolAgentProfileSupported();
033:
034: /**
035: * <em>Not yet implemented - do not call</em>. This is one of the online
036: * Process Definition Profile methods.
037: *
038: * @param scopingEntity
039: * @param entityClass
040: * @param entityName
041: * @return The workflow entity.
042: * @throws WMWorkflowException
043: */
044: WMEntity createEntity(WMEntity scopingEntity, String entityClass,
045: String entityName) throws WMWorkflowException;
046:
047: /**
048: * <em>Not yet implemented - do not call</em>. This is one of the online
049: * Process Definition Profile methods.
050: *
051: * @param scopingEntity
052: * @param filter
053: * @param countFlag
054: * @return An iterator for retrieving the selected entities.
055: * @throws WMWorkflowException
056: */
057: WMEntityIterator listEntities(WMEntity scopingEntity,
058: WMFilter filter, boolean countFlag)
059: throws WMWorkflowException;
060:
061: /**
062: * <em>Not yet implemented - do not call</em>. This is one of the online
063: * Process Definition Profile methods.
064: *
065: * @param scopingEntity
066: * @param entityId
067: * @throws WMWorkflowException
068: */
069: void deleteEntity(WMEntity scopingEntity, String entityId)
070: throws WMWorkflowException;
071:
072: /**
073: * <em>Not yet implemented - do not call</em>. This is one of the online
074: * Process Definition Profile methods.
075: *
076: * @param scopingEntity
077: * @param entityId
078: * @param filter
079: * @param countFlag
080: * @return An iterator for retrieving the selected entity attributes.
081: * @throws WMWorkflowException
082: */
083: WMAttributeIterator listEntityAttributes(WMEntity scopingEntity,
084: String entityId, WMFilter filter, boolean countFlag)
085: throws WMWorkflowException;
086:
087: // Spec. says param 3 is a WMEntity... does that really make sense?
088:
089: /**
090: * <em>Not yet implemented - do not call</em>. This is one of the online
091: * Process Definition Profile methods.
092: *
093: * @param scopingEntity
094: * @param entityHandle
095: * @param attributeName
096: * @return The entity attribute value.
097: * @throws WMWorkflowException
098: */
099: WMAttribute getEntityAttributeValue(WMEntity scopingEntity,
100: WMEntity entityHandle, String attributeName)
101: throws WMWorkflowException;
102:
103: // These methods are for retrieving multi-valued entity attributes.
104:
105: /**
106: * <em>Not yet implemented - do not call</em>. This is one of the online
107: * Process Definition Profile methods.
108: *
109: * @param scopingEntity
110: * @param entityHandle
111: * @param attributeName
112: * @return An iterator for retrieving the selected entity attribute values.
113: * @throws WMWorkflowException
114: */
115: WMAttributeIterator listEntityAttributeValues(
116: WMEntity scopingEntity, String entityHandle,
117: String attributeName) throws WMWorkflowException;
118:
119: /**
120: * <em>Not yet implemented - do not call</em>. This is one of the online
121: * Process Definition Profile methods.
122: *
123: * @param entityHandle
124: * @param attributeName
125: * @param attributeType
126: * @param attributeValue
127: * @throws WMWorkflowException
128: */
129: void assignEntityAttributeValue(WMEntity entityHandle,
130: String attributeName, int attributeType,
131: String attributeValue) throws WMWorkflowException;
132:
133: /**
134: * <em>Not yet implemented - do not call</em>. This is one of the online
135: * Process Definition Profile methods.
136: *
137: * @param entityHandle
138: * @param attributeName
139: * @throws WMWorkflowException
140: */
141: void clearEntityAttributeList(WMEntity entityHandle,
142: String attributeName) throws WMWorkflowException;
143:
144: /**
145: * <em>Not yet implemented - do not call</em>. This is one of the online
146: * Process Definition Profile methods.
147: *
148: * @param entityHandle
149: * @param attributeName
150: * @param attributeType
151: * @param attributeValue
152: * @throws WMWorkflowException
153: */
154: void addEntityAttributeValue(WMEntity entityHandle,
155: String attributeName, int attributeType,
156: String attributeValue) throws WMWorkflowException;
157:
158: /**
159: * <em>Not yet implemented - do not call</em>. This is one of the online
160: * Process Definition Profile methods.
161: *
162: * @param name
163: * @param scope
164: * @return The workflow definition entity.
165: * @throws WMWorkflowException
166: */
167: WMEntity openWorkflowDefinition(String name, String scope)
168: throws WMWorkflowException;
169:
170: /**
171: * <em>Not yet implemented - do not call</em>. This is one of the online
172: * Process Definition Profile methods.
173: *
174: * @param workflowDefinitionHandle
175: * @throws WMWorkflowException
176: */
177: void closeWorkflowDefinition(WMEntity workflowDefinitionHandle)
178: throws WMWorkflowException;
179:
180: /**
181: * <em>Not yet implemented - do not call</em>. This is one of the online
182: * Process Definition Profile methods.
183: *
184: * @return The package Id.
185: * @throws WMWorkflowException
186: */
187: String createPackage() throws WMWorkflowException;
188:
189: /**
190: * <em>Not yet implemented - do not call</em>. This is one of the online
191: * Process Definition Profile methods.
192: *
193: * @param processDefinitionId
194: * @throws WMWorkflowException
195: */
196: void deleteProcessDefinition(String processDefinitionId)
197: throws WMWorkflowException;
198:
199: // Spec. says param 2 is WMTPProcDefinition, but this isn't defined
200: // anywhere. In any case, for consistency it should be the procDefId.
201:
202: /**
203: * <em>Not yet implemented - do not call</em>. This is one of the online
204: * Process Definition Profile methods.
205: *
206: * @param procDefId
207: * @return The process definition entity.
208: * @throws WMWorkflowException
209: */
210: WMEntity openProcessDefinition(String procDefId)
211: throws WMWorkflowException;
212:
213: /**
214: * <em>Not yet implemented - do not call</em>. This is one of the online
215: * Process Definition Profile methods.
216: *
217: * @param procModelHandle
218: * @throws WMWorkflowException
219: */
220: void closeProcessDefinition(WMEntity procModelHandle)
221: throws WMWorkflowException;
222:
223: /**
224: * <em>Not yet implemented - do not call</em>. This is one of the online
225: * Process Definition Profile methods.
226: *
227: * @param procModelId
228: * @param sourceActDefId
229: * @param targetActDefId
230: * @return The transition entity.
231: * @throws WMWorkflowException
232: */
233: WMEntity addTransition(String procModelId, String sourceActDefId,
234: String targetActDefId) throws WMWorkflowException;
235:
236: /**
237: * <em>Not yet implemented - do not call</em>. This is one of the online
238: * Process Definition Profile methods.
239: *
240: * @param procModelId
241: * @param procDataId
242: * @param attributeName
243: * @param attributeType
244: * @param attributeLength
245: * @param attributeValue
246: * @throws WMWorkflowException
247: */
248: void addProcessDataAttribute(String procModelId, String procDataId,
249: String attributeName, int attributeType,
250: int attributeLength, String attributeValue)
251: throws WMWorkflowException;
252:
253: /**
254: * <em>Not yet implemented - do not call</em>. This is one of the online
255: * Process Definition Profile methods.
256: *
257: * @param procModelId
258: * @param procDataId
259: * @param attributeName
260: * @throws WMWorkflowException
261: */
262: void removeProcessDataAttribute(String procModelId,
263: String procDataId, String attributeName)
264: throws WMWorkflowException;
265: }
|