001: package org.enhydra.shark.api.common;
002:
003: import org.enhydra.shark.api.client.wfmc.wapi.WMFilter;
004: import org.enhydra.shark.api.client.wfmc.wapi.WMSessionHandle;
005:
006: /**
007: * All methods are returng the WMFilter object.
008: *
009: * @author V.Puskas
010: * @version 0.3
011: */
012: public interface ActivityFilterBuilder extends FilterBuilder {
013:
014: public int ACCEPTED_AND_NON_ACCEPTED = -1;
015:
016: public int ONLY_NON_ACCEPTED = 0;
017:
018: public int ONLY_ACCEPTED = 1;
019:
020: /**
021: * Sets condition "process definition id == value of exp"
022: */
023: public WMFilter addPackageIdEquals(WMSessionHandle sHandle,
024: String exp) throws Exception;
025:
026: /**
027: * Sets condition "process definition id == value of exp"
028: */
029: public WMFilter addProcessDefIdEquals(WMSessionHandle sHandle,
030: String exp) throws Exception;
031:
032: /**
033: * Sets condition "process manager name == value of exp"
034: */
035: public WMFilter addMgrNameEquals(WMSessionHandle sHandle, String exp)
036: throws Exception;
037:
038: /**
039: * Sets condition "process manager version == value of exp"
040: */
041: public WMFilter addVersionEquals(WMSessionHandle sHandle, String exp)
042: throws Exception;
043:
044: /**
045: * Sets condition "process manager is enabled"
046: */
047: public WMFilter addIsMgrEnabled(WMSessionHandle sHandle)
048: throws Exception;
049:
050: /**
051: * Sets condition "process state == value of exp"
052: */
053: public WMFilter addProcessStateEquals(WMSessionHandle sHandle,
054: String arg) throws Exception;
055:
056: /**
057: * Sets condition "process state starts with value of exp"
058: */
059: public WMFilter addProcessStateStartsWith(WMSessionHandle sHandle,
060: String arg) throws Exception;
061:
062: /**
063: * Sets condition "process id == value of exp"
064: */
065: public WMFilter addProcessIdEquals(WMSessionHandle sHandle,
066: String arg) throws Exception;
067:
068: /**
069: * Sets condition "process name == value of exp"
070: */
071: public WMFilter addProcessNameEquals(WMSessionHandle sHandle,
072: String arg) throws Exception;
073:
074: /**
075: * Sets condition "process name contains value of exp"
076: */
077: public WMFilter addProcessNameContains(WMSessionHandle sHandle,
078: String arg) throws Exception;
079:
080: /**
081: * Sets condition "process priority == value of exp"
082: */
083: public WMFilter addProcessPriorityEquals(WMSessionHandle sHandle,
084: int arg) throws Exception;
085:
086: /**
087: * Sets condition "process priority > value of exp"
088: */
089: public WMFilter addProcessPriorityGreaterThan(
090: WMSessionHandle sHandle, int arg) throws Exception;
091:
092: /**
093: * Sets condition "process priority < value of exp"
094: */
095: public WMFilter addProcessPriorityLessThan(WMSessionHandle sHandle,
096: int arg) throws Exception;
097:
098: /**
099: * Sets condition "process description == value of exp"
100: */
101: public WMFilter addProcessDescriptionEquals(
102: WMSessionHandle sHandle, String arg) throws Exception;
103:
104: /**
105: * Sets condition "process description contains value of exp"
106: */
107: public WMFilter addProcessDescriptionContains(
108: WMSessionHandle sHandle, String arg) throws Exception;
109:
110: /**
111: * Sets condition "process requester == value of exp"
112: */
113: public WMFilter addProcessRequesterIdEquals(
114: WMSessionHandle sHandle, String arg) throws Exception;
115:
116: public WMFilter addProcessRequesterUsernameEquals(
117: WMSessionHandle shandle, String arg) throws Exception;
118:
119: /**
120: * Sets condition "process created time == value of exp"
121: */
122: public WMFilter addProcessCreatedTimeEquals(
123: WMSessionHandle sHandle, long arg) throws Exception;
124:
125: /**
126: * Sets condition "process created time < value of exp"
127: */
128: public WMFilter addProcessCreatedTimeBefore(
129: WMSessionHandle sHandle, long arg) throws Exception;
130:
131: /**
132: * Sets condition "process created time > value of exp"
133: */
134: public WMFilter addProcessCreatedTimeAfter(WMSessionHandle sHandle,
135: long arg) throws Exception;
136:
137: /**
138: * Sets condition "process started time == value of exp"
139: */
140: public WMFilter addProcessStartTimeEquals(WMSessionHandle sHandle,
141: long arg) throws Exception;
142:
143: /**
144: * Sets condition "process started time < value of exp"
145: */
146: public WMFilter addProcessStartTimeBefore(WMSessionHandle sHandle,
147: long arg) throws Exception;
148:
149: /**
150: * Sets condition "process started time > value of exp"
151: */
152: public WMFilter addProcessStartTimeAfter(WMSessionHandle sHandle,
153: long arg) throws Exception;
154:
155: /**
156: * Sets condition "process last state time time == value of exp"
157: */
158: public WMFilter addProcessLastStateTimeEquals(
159: WMSessionHandle sHandle, long arg) throws Exception;
160:
161: /**
162: * Sets condition "process last state time time < value of exp"
163: */
164: public WMFilter addProcessLastStateTimeBefore(
165: WMSessionHandle sHandle, long arg) throws Exception;
166:
167: /**
168: * Sets condition "process last state time time > value of exp"
169: */
170: public WMFilter addProcessLastStateTimeAfter(
171: WMSessionHandle sHandle, long arg) throws Exception;
172:
173: /**
174: * Sets condition "process finish time == arg"
175: */
176: public WMFilter addProcessFinishTimeEquals(WMSessionHandle sHandle,
177: long arg) throws Exception;
178:
179: /**
180: * Sets condition "process finish time < arg"
181: */
182: public WMFilter addProcessFinishTimeBefore(WMSessionHandle sHandle,
183: long arg) throws Exception;
184:
185: /**
186: * Sets condition "process finish time > arg"
187: */
188: public WMFilter addProcessFinishTimeAfter(WMSessionHandle sHandle,
189: long arg) throws Exception;
190:
191: public WMFilter addProcessLimitTimeEquals(WMSessionHandle sHandle,
192: long arg) throws Exception;
193:
194: public WMFilter addProcessLimitTimeBefore(WMSessionHandle sHandle,
195: long arg) throws Exception;
196:
197: public WMFilter addProcessLimitTimeAfter(WMSessionHandle sHandle,
198: long arg) throws Exception;
199:
200: /**
201: * Sets condition "process variable vName == vValue"
202: */
203: public WMFilter addProcessVariableEquals(WMSessionHandle sHandle,
204: String vName, Object vValue) throws Exception;
205:
206: /**
207: * Sets condition "process variable vName == vValue"
208: */
209: public WMFilter addProcessVariableStringEquals(
210: WMSessionHandle sHandle, String vName, String vValue)
211: throws Exception;
212:
213: /**
214: * Sets condition "process variable vName == vValue"
215: */
216: public WMFilter addProcessVariableLongEquals(
217: WMSessionHandle sHandle, String vName, long vValue)
218: throws Exception;
219:
220: /**
221: * Sets condition "process variable vName > vValue"
222: */
223: public WMFilter addProcessVariableLongGreaterThan(
224: WMSessionHandle sHandle, String vName, long vValue)
225: throws Exception;
226:
227: /**
228: * Sets condition "process variable vName < vValue"
229: */
230: public WMFilter addProcessVariableLongLessThan(
231: WMSessionHandle sHandle, String vName, long vValue)
232: throws Exception;
233:
234: /**
235: * Sets condition "process variable vName == vValue"
236: */
237: public WMFilter addProcessVariableDoubleEquals(
238: WMSessionHandle sHandle, String vName, double vValue)
239: throws Exception;
240:
241: /**
242: * Sets condition "process variable vName > vValue"
243: */
244: public WMFilter addProcessVariableDoubleGreaterThan(
245: WMSessionHandle sHandle, String vName, double vValue)
246: throws Exception;
247:
248: /**
249: * Sets condition "process variable vName < vValue"
250: */
251: public WMFilter addProcessVariableDoubleLessThan(
252: WMSessionHandle sHandle, String vName, double vValue)
253: throws Exception;
254:
255: /**
256: * Sets condition "activity state == arg"
257: */
258: public WMFilter addStateEquals(WMSessionHandle sHandle, String arg)
259: throws Exception;
260:
261: /**
262: * Sets condition "activity state starts with arg"
263: */
264: public WMFilter addStateStartsWith(WMSessionHandle sHandle,
265: String arg) throws Exception;
266:
267: /**
268: * Sets condition "activity id == arg"
269: */
270: public WMFilter addIdEquals(WMSessionHandle sHandle, String arg)
271: throws Exception;
272:
273: /**
274: * Sets condition "activity name == arg"
275: */
276: public WMFilter addNameEquals(WMSessionHandle sHandle, String arg)
277: throws Exception;
278:
279: /**
280: * Sets condition "activity name contains arg"
281: */
282: public WMFilter addNameContains(WMSessionHandle sHandle, String arg)
283: throws Exception;
284:
285: /**
286: * Sets condition "activity priority == arg"
287: */
288: public WMFilter addPriorityEquals(WMSessionHandle sHandle, int arg)
289: throws Exception;
290:
291: /**
292: * Sets condition "activity priority > arg"
293: */
294: public WMFilter addPriorityGreaterThan(WMSessionHandle sHandle,
295: int arg) throws Exception;
296:
297: /**
298: * Sets condition "activity priority < arg"
299: */
300: public WMFilter addPriorityLessThan(WMSessionHandle sHandle, int arg)
301: throws Exception;
302:
303: /**
304: * Sets condition "activity description == arg"
305: */
306: public WMFilter addDescriptionEquals(WMSessionHandle sHandle,
307: String arg) throws Exception;
308:
309: /**
310: * Sets condition "activity description contains arg"
311: */
312: public WMFilter addDescriptionContains(WMSessionHandle sHandle,
313: String arg) throws Exception;
314:
315: /**
316: * Sets condition "activity activated time == arg"
317: */
318: public WMFilter addActivatedTimeEquals(WMSessionHandle sHandle,
319: long arg) throws Exception;
320:
321: /**
322: * Sets condition "activity activated time < arg"
323: */
324: public WMFilter addActivatedTimeBefore(WMSessionHandle sHandle,
325: long arg) throws Exception;
326:
327: /**
328: * Sets condition "activity activated time > arg"
329: */
330: public WMFilter addActivatedTimeAfter(WMSessionHandle sHandle,
331: long arg) throws Exception;
332:
333: /**
334: * Sets condition "activity last state time == arg"
335: */
336: public WMFilter addLastStateTimeEquals(WMSessionHandle sHandle,
337: long arg) throws Exception;
338:
339: /**
340: * Sets condition "activity last state time < arg"
341: */
342: public WMFilter addLastStateTimeBefore(WMSessionHandle sHandle,
343: long arg) throws Exception;
344:
345: /**
346: * Sets condition "activity last state time > arg"
347: */
348: public WMFilter addLastStateTimeAfter(WMSessionHandle sHandle,
349: long arg) throws Exception;
350:
351: /**
352: * Sets condition "activity accepted time == arg"
353: */
354: public WMFilter addAcceptedTimeEquals(WMSessionHandle sHandle,
355: long arg) throws Exception;
356:
357: /**
358: * Sets condition "activity accepted time < arg"
359: */
360: public WMFilter addAcceptedTimeBefore(WMSessionHandle sHandle,
361: long arg) throws Exception;
362:
363: /**
364: * Sets condition "activity accepted time > arg"
365: */
366: public WMFilter addAcceptedTimeAfter(WMSessionHandle sHandle,
367: long arg) throws Exception;
368:
369: /**
370: * Sets condition "activity finish time == arg"
371: */
372: public WMFilter addFinishTimeEquals(WMSessionHandle sHandle,
373: long arg) throws Exception;
374:
375: /**
376: * Sets condition "activity finish time < arg"
377: */
378: public WMFilter addFinishTimeBefore(WMSessionHandle sHandle,
379: long arg) throws Exception;
380:
381: /**
382: * Sets condition "activity finish time > arg"
383: */
384: public WMFilter addFinishTimeAfter(WMSessionHandle sHandle, long arg)
385: throws Exception;
386:
387: public WMFilter addLimitTimeEquals(WMSessionHandle sHandle, long arg)
388: throws Exception;
389:
390: public WMFilter addLimitTimeBefore(WMSessionHandle sHandle, long arg)
391: throws Exception;
392:
393: public WMFilter addLimitTimeAfter(WMSessionHandle sHandle, long arg)
394: throws Exception;
395:
396: /**
397: * Sets condition "activity variable vName == vValue"
398: */
399: public WMFilter addVariableEquals(WMSessionHandle sHandle,
400: String vName, Object vValue) throws Exception;
401:
402: /**
403: * Sets condition "activity variable vName == vValue"
404: */
405: public WMFilter addVariableStringEquals(WMSessionHandle sHandle,
406: String vName, String vValue) throws Exception;
407:
408: /**
409: * Sets condition "activity variable vName == vValue"
410: */
411: public WMFilter addVariableLongEquals(WMSessionHandle sHandle,
412: String vName, long vValue) throws Exception;
413:
414: /**
415: * Sets condition "activity variable vName > vValue"
416: */
417: public WMFilter addVariableLongGreaterThan(WMSessionHandle sHandle,
418: String vName, long vValue) throws Exception;
419:
420: /**
421: * Sets condition "activity variable vName < vValue"
422: */
423: public WMFilter addVariableLongLessThan(WMSessionHandle sHandle,
424: String vName, long vValue) throws Exception;
425:
426: /**
427: * Sets condition "activity variable vName == vValue"
428: */
429: public WMFilter addVariableDoubleEquals(WMSessionHandle sHandle,
430: String vName, double vValue) throws Exception;
431:
432: /**
433: * Sets condition "activity variable vName > vValue"
434: */
435: public WMFilter addVariableDoubleGreaterThan(
436: WMSessionHandle sHandle, String vName, double vValue)
437: throws Exception;
438:
439: /**
440: * Sets condition "activity variable vName < vValue"
441: */
442: public WMFilter addVariableDoubleLessThan(WMSessionHandle sHandle,
443: String vName, double vValue) throws Exception;
444:
445: /**
446: * Sets condition "activity set definition id == arg"
447: */
448: public WMFilter addActivitySetDefIdEquals(WMSessionHandle sHandle,
449: String arg) throws Exception;
450:
451: /**
452: * Sets condition "activity definition id == arg"
453: */
454: public WMFilter addDefinitionIdEquals(WMSessionHandle sHandle,
455: String arg) throws Exception;
456:
457: /**
458: * Sets condition "activity is accepted"
459: */
460: public WMFilter addIsAccepted(WMSessionHandle sHandle)
461: throws Exception;
462:
463: /**
464: * Sets condition "activity resource username == arg"
465: */
466: public WMFilter addResourceUsernameEquals(WMSessionHandle sHandle,
467: String arg) throws Exception;
468:
469: /**
470: * Gets activities that have assignment for the user. It can be specified to get
471: * activities only for accepted assignments, only for non-accepted, and for both
472: * accepted and non-accepted.
473: */
474: public WMFilter addHasAssignmentForUser(WMSessionHandle sHandle,
475: String username, int acceptedStatus) throws Exception;
476:
477: /**
478: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
479: * (nor its evaluation), rather they affect sorting of the result.
480: * <p>
481: * This method sets ordering by activity id.
482: */
483: public WMFilter setOrderById(WMSessionHandle sHandle,
484: WMFilter filter, boolean ascending) throws Exception;
485:
486: /**
487: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
488: * (nor its evaluation), rather they affect sorting of the result.
489: * <p>
490: * This method sets ordering by activity set definition id.
491: */
492: public WMFilter setOrderByActivitySetDefId(WMSessionHandle sHandle,
493: WMFilter filter, boolean ascending) throws Exception;
494:
495: /**
496: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
497: * (nor its evaluation), rather they affect sorting of the result.
498: * <p>
499: * This method sets ordering by activity definition id.
500: */
501: public WMFilter setOrderByDefinitionId(WMSessionHandle sHandle,
502: WMFilter filter, boolean ascending) throws Exception;
503:
504: /**
505: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
506: * (nor its evaluation), rather they affect sorting of the result.
507: * <p>
508: * This method sets ordering by process id.
509: */
510: public WMFilter setOrderByProcessId(WMSessionHandle sHandle,
511: WMFilter filter, boolean ascending) throws Exception;
512:
513: /**
514: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
515: * (nor its evaluation), rather they affect sorting of the result.
516: * <p>
517: * This method sets ordering by resource username.
518: */
519: public WMFilter setOrderByResourceUsername(WMSessionHandle sHandle,
520: WMFilter filter, boolean ascending) throws Exception;
521:
522: /**
523: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
524: * (nor its evaluation), rather they affect sorting of the result.
525: * <p>
526: * This method sets ordering by process manager name value.
527: */
528: public WMFilter setOrderByProcessDefName(WMSessionHandle sHandle,
529: WMFilter filter, boolean ascending) throws Exception;
530:
531: /**
532: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
533: * (nor its evaluation), rather they affect sorting of the result.
534: * <p>
535: * This method sets ordering by activity state.
536: */
537: public WMFilter setOrderByState(WMSessionHandle sHandle,
538: WMFilter filter, boolean ascending) throws Exception;
539:
540: /**
541: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
542: * (nor its evaluation), rather they affect sorting of the result.
543: * <p>
544: * This method sets ordering by performer value.
545: */
546: public WMFilter setOrderByPerformer(WMSessionHandle sHandle,
547: WMFilter filter, boolean ascending) throws Exception;
548:
549: /**
550: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
551: * (nor its evaluation), rather they affect sorting of the result.
552: * <p>
553: * This method sets ordering by priority value.
554: */
555: public WMFilter setOrderByPriority(WMSessionHandle sHandle,
556: WMFilter filter, boolean ascending) throws Exception;
557:
558: /**
559: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
560: * (nor its evaluation), rather they affect sorting of the result.
561: * <p>
562: * This method sets ordering by activity name value.
563: */
564: public WMFilter setOrderByName(WMSessionHandle sHandle,
565: WMFilter filter, boolean ascending) throws Exception;
566:
567: /**
568: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
569: * (nor its evaluation), rather they affect sorting of the result.
570: * <p>
571: * This method sets ordering by activity activated time value.
572: */
573: public WMFilter setOrderByActivatedTime(WMSessionHandle sHandle,
574: WMFilter filter, boolean ascending) throws Exception;
575:
576: /**
577: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
578: * (nor its evaluation), rather they affect sorting of the result.
579: * <p>
580: * This method sets ordering by activity accepted time value.
581: */
582: public WMFilter setOrderByAcceptedTime(WMSessionHandle sHandle,
583: WMFilter filter, boolean ascending) throws Exception;
584:
585: /**
586: * Methods starting with <tt>setOrderBy</tt> obviously don't affect actual expression
587: * (nor its evaluation), rather they affect sorting of the result.
588: * <p>
589: * This method sets ordering by last state time value.
590: */
591: public WMFilter setOrderByLastStateTime(WMSessionHandle sHandle,
592: WMFilter filter, boolean ascending) throws Exception;
593: }
|