Java > Open Source Codes > org > enhydra > shark > api > client > wfservice > AdminMisc


1 package org.enhydra.shark.api.client.wfservice;
2
3 import org.enhydra.shark.api.SharkTransaction;
4 import org.enhydra.shark.api.client.wfbase.BaseException;
5
6 /**
7  * Interface used to perform some administrative operations.
8  * @author Sasa Bojanic
9  * @author Vladimir Puskas
10  */
11 public interface AdminMisc {
12
13    /**
14     * This method is used to let shark know who uses this API.
15     *
16     * @param userId String representing user Id.
17     *
18     */
19    void connect (String userId);
20
21    /**
22     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
23     * elements of XPDL package definition for the current version of package that has
24     * the given Id.
25     *
26     * @param pkgId package Id.
27     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
28     * elements of the package.
29     * @throws BaseException If something unexpected happens
30     */
31    String [][] getPackageExtendedAttributeNameValuePairs (String pkgId) throws BaseException;
32
33    /**
34     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
35     * elements of XPDL package definition for the current version of package that has
36     * the given Id.
37     *
38     * @param t SharkTransaction.
39     * @param pkgId package Id.
40     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
41     * elements of the package.
42     * @throws BaseException If something unexpected happens
43     */
44    String [][] getPackageExtendedAttributeNameValuePairs (SharkTransaction t,String pkgId) throws BaseException;
45
46    /**
47     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
48     * package definition for the current version of package that has the given Id.
49     *
50     * @param pkgId package Id.
51     * @return The names of all specified XPDL ExtendedAttribute elements of
52     * the package.
53     * @throws BaseException If something unexpected happens
54     */
55    String [] getPackageExtendedAttributeNames (String pkgId) throws BaseException;
56
57    /**
58     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
59     * package definition for the current version of package that has the given Id.
60     *
61     * @param t SharkTransaction.
62     * @param pkgId package Id.
63     * @return The names of all specified XPDL ExtendedAttribute elements of
64     * the package.
65     * @throws BaseException If something unexpected happens
66     */
67    String [] getPackageExtendedAttributeNames (SharkTransaction t,String pkgId) throws BaseException;
68
69    /**
70     * Returns string representation of the value of specified XPDL ExtendedAttribute
71     * of XPDL package definition for the current version of the package that has the given Id.
72     *
73     * @param pkgId package Id.
74     * @param extAttrName the name of XPDL ext. attribute.
75     * @return The value of specified XPDL ExtendedAttribute of the package.
76     * @throws BaseException If something unexpected happens (i.e. if there
77     * are is no such ext. attr)
78     */
79    String getPackageExtendedAttributeValue (String pkgId,String extAttrName) throws BaseException;
80
81    /**
82     * Returns string representation of the value of specified XPDL ExtendedAttribute
83     * of XPDL package definition for the current version of the package that has the given Id.
84     *
85     * @param t SharkTransaction.
86     * @param pkgId package Id.
87     * @param extAttrName the name of XPDL ext. attribute.
88     * @return The value of specified XPDL ExtendedAttribute of the package.
89     * @throws BaseException If something unexpected happens (i.e. if there
90     * are is no such ext. attr)
91     */
92    String getPackageExtendedAttributeValue (SharkTransaction t,String pkgId,String extAttrName) throws BaseException;
93
94    /**
95     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
96     * elements of XPDL process definition for the process manager with a
97     * given name.
98     *
99     * @param mgrName manager name.
100     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
101     * elements of the process.
102     * @throws BaseException If something unexpected happens
103     */
104    String [][] getProcessDefinitionExtendedAttributeNameValuePairs (String mgrName) throws BaseException;
105
106    /**
107     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
108     * elements of XPDL process definition for the process manager with a
109     * given name.
110     *
111     * @param t SharkTransaction.
112     * @param mgrName manager name.
113     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
114     * elements of the process.
115     * @throws BaseException If something unexpected happens
116     */
117    String [][] getProcessDefinitionExtendedAttributeNameValuePairs (SharkTransaction t,String mgrName) throws BaseException;
118
119    /**
120     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
121     * process definition for the process manager with a given name.
122     *
123     * @param mgrName manager name.
124     * @return The names of all specified XPDL ExtendedAttribute elements of
125     * the process.
126     * @throws BaseException If something unexpected happens
127     */
128    String [] getProcessDefinitionExtendedAttributeNames (String mgrName) throws BaseException;
129
130    /**
131     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
132     * process definition for the process manager with a given name.
133     *
134     * @param t SharkTransaction.
135     * @param mgrName manager name.
136     * @return The names of all specified XPDL ExtendedAttribute elements of
137     * the process.
138     * @throws BaseException If something unexpected happens
139     */
140    String [] getProcessDefinitionExtendedAttributeNames (SharkTransaction t,String mgrName) throws BaseException;
141
142    /**
143     * Returns string representation of the value of specified XPDL ExtendedAttribute
144     * of XPDL process definition for the process manager with a given Id.
145     *
146     * @param mgrName manager name.
147     * @param extAttrName the name of XPDL ext. attribute.
148     * @return The value of specified XPDL ExtendedAttribute of the process.
149     * @throws BaseException If something unexpected happens (i.e. if there
150     * are is no such ext. attr)
151     */
152    String getProcessDefinitionExtendedAttributeValue (String mgrName,String extAttrName) throws BaseException;
153
154    /**
155     * Returns string representation of the value of specified XPDL ExtendedAttribute
156     * of XPDL process definition for the process manager with a given Id.
157     *
158     * @param t SharkTransaction.
159     * @param mgrName manager name.
160     * @param extAttrName the name of XPDL ext. attribute.
161     * @return The value of specified XPDL ExtendedAttribute of the process.
162     * @throws BaseException If something unexpected happens (i.e. if there
163     * are is no such ext. attr)
164     */
165    String getProcessDefinitionExtendedAttributeValue (SharkTransaction t,String mgrName,String extAttrName) throws BaseException;
166
167    /**
168     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
169     * elements of XPDL process definition for the process instance with a
170     * given name.
171     *
172     * @param procId process Id.
173     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
174     * elements of the process.
175     * @throws BaseException If something unexpected happens
176     */
177    String [][] getProcessExtendedAttributeNameValuePairs (String procId) throws BaseException;
178
179    /**
180     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
181     * elements of XPDL process definition for the process instance that has
182     * the given Id.
183     *
184     * @param t SharkTransaction.
185     * @param procId process Id.
186     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
187     * elements of the process.
188     * @throws BaseException If something unexpected happens
189     */
190    String [][] getProcessExtendedAttributeNameValuePairs (SharkTransaction t,String procId) throws BaseException;
191
192    /**
193     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
194     * process definition for the process instance that has the given Id.
195     *
196     * @param procId process Id.
197     * @return The names of all specified XPDL ExtendedAttribute elements of
198     * the process.
199     * @throws BaseException If something unexpected happens
200     */
201    String [] getProcessExtendedAttributeNames (String procId) throws BaseException;
202
203    /**
204     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
205     * process definition for the process instance that has the given Id.
206     *
207     * @param t SharkTransaction.
208     * @param procId process Id.
209     * @return The names of all specified XPDL ExtendedAttribute elements of
210     * the process.
211     * @throws BaseException If something unexpected happens
212     */
213    String [] getProcessExtendedAttributeNames (SharkTransaction t,String procId) throws BaseException;
214
215    /**
216     * Returns string representation of the value of specified XPDL ExtendedAttribute
217     * of XPDL process definition for the process instance that has the given Id.
218     *
219     * @param procId process Id.
220     * @param extAttrName the name of XPDL ext. attribute.
221     * @return The value of specified XPDL ExtendedAttribute of the process.
222     * @throws BaseException If something unexpected happens (i.e. if there
223     * are is no such ext. attr)
224     */
225    String getProcessExtendedAttributeValue (String procId,String extAttrName) throws BaseException;
226
227    /**
228     * Returns string representation of the value of specified XPDL ExtendedAttribute
229     * of XPDL process definition for the process instance that has the given Id.
230     *
231     * @param t SharkTransaction.
232     * @param procId process Id.
233     * @param extAttrName the name of XPDL ext. attribute.
234     * @return The value of specified XPDL ExtendedAttribute of the process.
235     * @throws BaseException If something unexpected happens (i.e. if there
236     * are is no such ext. attr)
237     */
238    String getProcessExtendedAttributeValue (SharkTransaction t,String procId,String extAttrName) throws BaseException;
239
240    /**
241     * Returns string representation of XPDL ExtendedAttributes tag content of
242     * XPDL activity definition for the activity instance that has the given Id.
243     *
244     * @param procId activity's process Id.
245     * @param actId Id of activity instance.
246     * @return The ExtendedAttributes tag content of XPDL definition of the
247     * activity.
248     * @throws BaseException If something unexpected happens.
249     */
250    String getActivitiesExtendedAttributes (String procId,String actId) throws BaseException;
251
252    /**
253     * Returns string representation of XPDL ExtendedAttributes tag content of
254     * XPDL activity definition for the activity instance that has the given Id.
255     *
256     * @param t SharkTransaction.
257     * @param procId activity's process Id.
258     * @param actId Id of activity instance.
259     * @return The ExtendedAttributes tag content of XPDL definition of the
260     * activity.
261     * @throws BaseException If something unexpected happens.
262     */
263    String getActivitiesExtendedAttributes (SharkTransaction t,String procId,String actId) throws BaseException;
264
265    /**
266     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
267     * elements of XPDL activity definition for the activity instance that has
268     * the given Id.
269     *
270     * @param procId activity's process Id.
271     * @param actId Id of activity instance.
272     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
273     * elements of the activity.
274     * @throws BaseException If something unexpected happens
275     */
276    String [][] getActivitiesExtendedAttributeNameValuePairs (String procId,String actId) throws BaseException;
277
278    /**
279     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
280     * elements of XPDL activity definition for the activity instance that has
281     * the given Id.
282     *
283     * @param t SharkTransaction.
284     * @param procId activity's process Id.
285     * @param actId Id of activity instance.
286     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
287     * elements of the activity.
288     * @throws BaseException If something unexpected happens
289     */
290    String [][] getActivitiesExtendedAttributeNameValuePairs (SharkTransaction t,String procId,String actId) throws BaseException;
291
292    /**
293     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
294     * activity definition for the activity instance that has the given Id.
295     *
296     * @param procId activity's process Id.
297     * @param actId Id of activity instance.
298     * @return The names of all specified XPDL ExtendedAttribute elements of
299     * the activity.
300     * @throws BaseException If something unexpected happens
301     */
302    String [] getActivitiesExtendedAttributeNames (String procId,String actId) throws BaseException;
303
304    /**
305     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
306     * activity definition for the activity instance that has the given Id.
307     *
308     * @param t SharkTransaction.
309     * @param procId activity's process Id.
310     * @param actId Id of activity instance.
311     * @return The names of all specified XPDL ExtendedAttribute elements of
312     * the activity.
313     * @throws BaseException If something unexpected happens
314     */
315    String [] getActivitiesExtendedAttributeNames (SharkTransaction t,String procId,String actId) throws BaseException;
316
317    /**
318     * Returns string representation of the value of specified XPDL ExtendedAttribute
319     * of XPDL activity definition for the activity instance that has the given Id.
320     *
321     * @param procId activity's process Id.
322     * @param actId Id of activity instance.
323     * @param extAttrName the name of XPDL ext. attribute.
324     * @return The value of specified XPDL ExtendedAttribute of the activity.
325     * @throws BaseException If something unexpected happens (i.e. if there
326     * are is no such ext. attr)
327     */
328    String getActivitiesExtendedAttributeValue (String procId,String actId,String extAttrName) throws BaseException;
329
330    /**
331     * Returns string representation of the value of specified XPDL ExtendedAttribute
332     * of XPDL activity definition for the activity instance that has the given Id.
333     *
334     * @param t SharkTransaction.
335     * @param procId activity's process Id.
336     * @param actId Id of activity instance.
337     * @param extAttrName the name of XPDL ext. attribute.
338     * @return The value of specified XPDL ExtendedAttribute of the activity.
339     * @throws BaseException If something unexpected happens (i.e. if there
340     * are is no such ext. attr)
341     */
342    String getActivitiesExtendedAttributeValue (SharkTransaction t,String procId,String actId,String extAttrName) throws BaseException;
343
344    /**
345     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
346     * elements of XPDL variable that can be determined by the given parameters.
347     * If there is no such variable, BaseException will be thrown..
348     *
349     * @param mgrName manager name.
350     * @param variableId Id of XPDL variable definition.
351     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
352     * elements of XPDL variable.
353     * @throws BaseException If something unexpected happens
354     */
355    String [][] getDefVariableExtendedAttributeNameValuePairs (String mgrName,String variableId) throws BaseException;
356
357    /**
358     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
359     * elements of XPDL variable that can be determined by the given parameters.
360     * If there is no such variable, BaseException will be thrown.
361     *
362     * @param t SharkTransaction.
363     * @param mgrName manager name.
364     * @param variableId Id of XPDL variable definition.
365     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
366     * elements of XPDL variable.
367     * @throws BaseException If something unexpected happens
368     */
369    String [][] getDefVariableExtendedAttributeNameValuePairs (SharkTransaction t,String mgrName,String variableId) throws BaseException;
370
371    /**
372     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
373     * variable that can be determined by the given parameters.
374     * If there is no such variable, BaseException will be thrown.
375     *
376     * @param mgrName manager name.
377     * @param variableId Id of XPDL variable definition.
378     * @return The names of all specified XPDL ExtendedAttribute elements of
379     * XPDL variable.
380     * @throws BaseException If something unexpected happens
381     */
382    String [] getDefVariableExtendedAttributeNames (String mgrName,String variableId) throws BaseException;
383
384    /**
385     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
386     * variable that can be determined by the given parameters.
387     * If there is no such variable, BaseException will be thrown.
388     *
389     * @param t SharkTransaction.
390     * @param mgrName manager name.
391     * @param variableId Id of XPDL variable definition.
392     * @return The names of all specified XPDL ExtendedAttribute elements of
393     * XPDL variable.
394     * @throws BaseException If something unexpected happens
395     */
396    String [] getDefVariableExtendedAttributeNames (SharkTransaction t,String mgrName,String variableId) throws BaseException;
397
398    /**
399     * Returns string representation of the value of specified XPDL ExtendedAttribute
400     * of XPDL variable that can be determined by the given parameters.
401     * If there is no such variable, BaseException will be thrown.
402     *
403     * @param mgrName manager name.
404     * @param variableId Id of XPDL variable definition.
405     * @param extAttrName the name of XPDL ext. attribute.
406     * @return The value of specified XPDL ExtendedAttribute of XPDL variable.
407     * @throws BaseException If something unexpected happens (i.e. if there
408     * are is no such ext. attr)
409     */
410    String getDefVariableExtendedAttributeValue (String mgrName,String variableId,String extAttrName) throws BaseException;
411
412    /**
413     * Returns string representation of the value of specified XPDL ExtendedAttribute
414     * of XPDL variable that can be determined by the given parameters.
415     * If there is no such variable, BaseException will be thrown.
416     *
417     * @param t SharkTransaction.
418     * @param mgrName manager name.
419     * @param variableId Id of XPDL variable definition.
420     * @param extAttrName the name of XPDL ext. attribute.
421     * @return The value of specified XPDL ExtendedAttribute of XPDL variable.
422     * @throws BaseException If something unexpected happens (i.e. if there
423     * are is no such ext. attr)
424     */
425    String getDefVariableExtendedAttributeValue (SharkTransaction t,String mgrName,String variableId,String extAttrName) throws BaseException;
426
427    /**
428     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
429     * elements of XPDL variable that can be determined by the given parameters.
430     * If there is no such variable, BaseException will be thrown..
431     *
432     * @param procId activity's process Id.
433     * @param variableId Id of XPDL variable definition.
434     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
435     * elements of XPDL variable.
436     * @throws BaseException If something unexpected happens
437     */
438    String [][] getVariableExtendedAttributeNameValuePairs (String procId,String variableId) throws BaseException;
439
440    /**
441     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
442     * elements of XPDL variable that can be determined by the given parameters.
443     * If there is no such variable, BaseException will be thrown.
444     *
445     * @param t SharkTransaction.
446     * @param procId activity's process Id.
447     * @param variableId Id of XPDL variable definition.
448     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
449     * elements of XPDL variable.
450     * @throws BaseException If something unexpected happens
451     */
452    String [][] getVariableExtendedAttributeNameValuePairs (SharkTransaction t,String procId,String variableId) throws BaseException;
453
454    /**
455     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
456     * variable that can be determined by the given parameters.
457     * If there is no such variable, BaseException will be thrown.
458     *
459     * @param procId activity's process Id.
460     * @param variableId Id of XPDL variable definition.
461     * @return The names of all specified XPDL ExtendedAttribute elements of
462     * XPDL variable.
463     * @throws BaseException If something unexpected happens
464     */
465    String [] getVariableExtendedAttributeNames (String procId,String variableId) throws BaseException;
466
467    /**
468     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
469     * variable that can be determined by the given parameters.
470     * If there is no such variable, BaseException will be thrown.
471     *
472     * @param t SharkTransaction.
473     * @param procId activity's process Id.
474     * @param variableId Id of XPDL variable definition.
475     * @return The names of all specified XPDL ExtendedAttribute elements of
476     * XPDL variable.
477     * @throws BaseException If something unexpected happens
478     */
479    String [] getVariableExtendedAttributeNames (SharkTransaction t,String procId,String variableId) throws BaseException;
480
481    /**
482     * Returns string representation of the value of specified XPDL ExtendedAttribute
483     * of XPDL variable that can be determined by the given parameters.
484     * If there is no such variable, BaseException will be thrown.
485     *
486     * @param procId activity's process Id.
487     * @param variableId Id of XPDL variable definition.
488     * @param extAttrName the name of XPDL ext. attribute.
489     * @return The value of specified XPDL ExtendedAttribute of XPDL variable.
490     * @throws BaseException If something unexpected happens (i.e. if there
491     * are is no such ext. attr)
492     */
493    String getVariableExtendedAttributeValue (String procId,String variableId,String extAttrName) throws BaseException;
494
495    /**
496     * Returns string representation of the value of specified XPDL ExtendedAttribute
497     * of XPDL variable that can be determined by the given parameters.
498     * If there is no such variable, BaseException will be thrown.
499     *
500     * @param t SharkTransaction.
501     * @param procId activity's process Id.
502     * @param variableId Id of XPDL variable definition.
503     * @param extAttrName the name of XPDL ext. attribute.
504     * @return The value of specified XPDL ExtendedAttribute of XPDL variable.
505     * @throws BaseException If something unexpected happens (i.e. if there
506     * are is no such ext. attr)
507     */
508    String getVariableExtendedAttributeValue (SharkTransaction t,String procId,String variableId,String extAttrName) throws BaseException;
509
510    /**
511     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
512     * elements of XPDL participant that can be determined by the given parameters.
513     * If there is no such participant, BaseException will be thrown..
514     *
515     * @param pkgId Id of participant's package.
516     * @param pDefId Id of participant's process (null if participant is from process level).
517     * @param participantId Id of participant.
518     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
519     * elements of XPDL participant.
520     * @throws BaseException If something unexpected happens
521     */
522    String [][] getParticipantExtendedAttributeNameValuePairs (String pkgId,String pDefId,String participantId) throws BaseException;
523
524    /**
525     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
526     * elements of XPDL participant that can be determined by the given parameters.
527     * If there is no such participant, BaseException will be thrown.
528     *
529     * @param t SharkTransaction.
530     * @param pkgId Id of participant's package.
531     * @param pDefId Id of participant's process (null if participant is from process level).
532     * @param participantId Id of participant.
533     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
534     * elements of XPDL participant.
535     * @throws BaseException If something unexpected happens
536     */
537    String [][] getParticipantExtendedAttributeNameValuePairs (SharkTransaction t,String pkgId,String pDefId,String participantId) throws BaseException;
538
539    /**
540     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
541     * participant that can be determined by the given parameters.
542     * If there is no such participant, BaseException will be thrown.
543     *
544     * @param pkgId Id of participant's package.
545     * @param pDefId Id of participant's process (null if participant is from process level).
546     * @param participantId Id of participant.
547     * @return The names of all specified XPDL ExtendedAttribute elements of
548     * XPDL participant.
549     * @throws BaseException If something unexpected happens
550     */
551    String [] getParticipantExtendedAttributeNames (String pkgId,String pDefId,String participantId) throws BaseException;
552
553    /**
554     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
555     * participant that can be determined by the given parameters.
556     * If there is no such participant, BaseException will be thrown.
557     *
558     * @param t SharkTransaction.
559     * @param pkgId Id of participant's package.
560     * @param pDefId Id of participant's process (null if participant is from process level).
561     * @param participantId Id of participant.
562     * @return The names of all specified XPDL ExtendedAttribute elements of
563     * XPDL participant.
564     * @throws BaseException If something unexpected happens
565     */
566    String [] getParticipantExtendedAttributeNames (SharkTransaction t,String pkgId,String pDefId,String participantId) throws BaseException;
567
568    /**
569     * Returns string representation of the value of specified XPDL ExtendedAttribute
570     * of XPDL participant that can be determined by the given parameters.
571     * If there is no such participant, BaseException will be thrown.
572     *
573     * @param pkgId Id of participant's package.
574     * @param pDefId Id of participant's process (null if participant is from process level).
575     * @param participantId Id of participant.
576     * @param extAttrName the name of XPDL ext. attribute.
577     * @return The value of specified XPDL ExtendedAttribute of XPDL participant.
578     * @throws BaseException If something unexpected happens (i.e. if there
579     * are is no such ext. attr)
580     */
581    String getParticipantExtendedAttributeValue (String pkgId,String pDefId,String participantId,String extAttrName) throws BaseException;
582
583    /**
584     * Returns string representation of the value of specified XPDL ExtendedAttribute
585     * of XPDL participant that can be determined by the given parameters.
586     * If there is no such participant, BaseException will be thrown.
587     *
588     * @param t SharkTransaction.
589     * @param pkgId Id of participant's package.
590     * @param pDefId Id of participant's process (null if participant is from process level).
591     * @param participantId Id of participant.
592     * @param extAttrName the name of XPDL ext. attribute.
593     * @return The value of specified XPDL ExtendedAttribute of XPDL participant.
594     * @throws BaseException If something unexpected happens (i.e. if there
595     * are is no such ext. attr)
596     */
597    String getParticipantExtendedAttributeValue (SharkTransaction t,String pkgId,String pDefId,String participantId,String extAttrName) throws BaseException;
598
599    /**
600     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
601     * elements of XPDL application that can be determined by the given parameters.
602     * If there is no such application, BaseException will be thrown..
603     *
604     * @param pkgId Id of application's package.
605     * @param pDefId Id of application's process (null if application is from process level).
606     * @param applicationId Id of application.
607     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
608     * elements of XPDL application.
609     * @throws BaseException If something unexpected happens
610     */
611    String [][] getApplicationExtendedAttributeNameValuePairs (String pkgId,String pDefId,String applicationId) throws BaseException;
612
613    /**
614     * Returns the [name,value] pairs of all specified XPDL ExtendedAttribute
615     * elements of XPDL application that can be determined by the given parameters.
616     * If there is no such application, BaseException will be thrown.
617     *
618     * @param t SharkTransaction.
619     * @param pkgId Id of application's package.
620     * @param pDefId Id of application's process (null if application is from process level).
621     * @param applicationId Id of application.
622     * @return The [name,value] pairs of all specified XPDL ExtendedAttribute
623     * elements of XPDL application.
624     * @throws BaseException If something unexpected happens
625     */
626    String [][] getApplicationExtendedAttributeNameValuePairs (SharkTransaction t,String pkgId,String pDefId,String applicationId) throws BaseException;
627
628    /**
629     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
630     * application that can be determined by the given parameters.
631     * If there is no such application, BaseException will be thrown.
632     *
633     * @param pkgId Id of application's package.
634     * @param pDefId Id of application's process (null if application is from process level).
635     * @param applicationId Id of application.
636     * @return The names of all specified XPDL ExtendedAttribute elements of
637     * XPDL application.
638     * @throws BaseException If something unexpected happens
639     */
640    String [] getApplicationExtendedAttributeNames (String pkgId,String pDefId,String applicationId) throws BaseException;
641
642    /**
643     * Returns the names of all specified XPDL ExtendedAttribute elements of XPDL
644     * application that can be determined by the given parameters.
645     * If there is no such application, BaseException will be thrown.
646     *
647     * @param t SharkTransaction.
648     * @param pkgId Id of application's package.
649     * @param pDefId Id of application's process (null if application is from process level).
650     * @param applicationId Id of application.
651     * @return The names of all specified XPDL ExtendedAttribute elements of
652     * XPDL application.
653     * @throws BaseException If something unexpected happens
654     */
655    String [] getApplicationExtendedAttributeNames (SharkTransaction t,String pkgId,String pDefId,String applicationId) throws BaseException;
656
657    /**
658     * Returns string representation of the value of specified XPDL ExtendedAttribute
659     * of XPDL application that can be determined by the given parameters.
660     * If there is no such application, BaseException will be thrown.
661     *
662     * @param pkgId Id of application's package.
663     * @param pDefId Id of application's process (null if application is from process level).
664     * @param applicationId Id of application.
665     * @param extAttrName the name of XPDL ext. attribute.
666     * @return The value of specified XPDL ExtendedAttribute of XPDL application.
667     * @throws BaseException If something unexpected happens (i.e. if there
668     * are is no such ext. attr)
669     */
670    String getApplicationExtendedAttributeValue (String pkgId,String pDefId,String applicationId,String extAttrName) throws BaseException;
671
672    /**
673     * Returns string representation of the value of specified XPDL ExtendedAttribute
674     * of XPDL application that can be determined by the given parameters.
675     * If there is no such application, BaseException will be thrown.
676     *
677     * @param t SharkTransaction.
678     * @param pkgId Id of application's package.
679     * @param pDefId Id of application's process (null if application is from process level).
680     * @param applicationId Id of application.
681     * @param extAttrName the name of XPDL ext. attribute.
682     * @return The value of specified XPDL ExtendedAttribute of XPDL application.
683     * @throws BaseException If something unexpected happens (i.e. if there
684     * are is no such ext. attr)
685     */
686    String getApplicationExtendedAttributeValue (SharkTransaction t,String pkgId,String pDefId,String applicationId,String extAttrName) throws BaseException;
687
688    /**
689     * Returns string representing the Id of block activity instance of
690     * activity instance that has the given Id.
691     *
692     * @param procId activity's process Id.
693     * @param actId Id of activity instance that we search block
694     * activity instance Id for.
695     * @return block activity instance Id if there is one for the given
696     * activity instance, or null if given activity does not belong to the block.
697     * @throws BaseException If something unexpected happens.
698     */
699    String getBlockActivityId (String procId,String actId) throws BaseException;
700
701    /**
702     * Returns string representing the Id of block activity instance of
703     * activity instance that has the given Id.
704     *
705     * @param t SharkTransaction.
706     * @param procId activity's process Id.
707     * @param actId Id of activity instance that we search block
708     * activity instance Id for.
709     * @return block activity instance Id if there is one for the given
710     * activity instance, or null if given activity does not belong to the block.
711     * @throws BaseException If something unexpected happens.
712     */
713    String getBlockActivityId (SharkTransaction t,String procId,String actId) throws BaseException;
714
715    /**
716     * Returns string representing the XPDL definition Id of activity
717     * instance that has the given Id.
718     *
719     * @param procId activity's process Id.
720     * @param actId Id of activity instance.
721     * @return XPDL activity definition Id for the given activity instance.
722     * @throws BaseException If something unexpected happens.
723     */
724    String getActivityDefinitionId (String procId,String actId) throws BaseException;
725
726    /**
727     * Returns string representing the XPDL definition Id of activity
728     * instance that has the given Id.
729     *
730     * @param t SharkTransaction.
731     * @param procId activity's process Id.
732     * @param actId Id of activity instance.
733     * @return XPDL activity definition Id for the given activity instance.
734     * @throws BaseException If something unexpected happens.
735     */
736    String getActivityDefinitionId (SharkTransaction t,String procId,String actId) throws BaseException;
737
738    /**
739     * Returns string representing the XPDL definition Id of process
740     * instance that has the given Id.
741     *
742     * @param procId Id of process instance.
743     * @return XPDL process definition Id for the given process instance.
744     * @throws BaseException If something unexpected happens.
745     */
746    String getProcessDefinitionId (String procId) throws BaseException;
747
748    /**
749     * Returns string representing the XPDL definition Id of process
750     * instance that has the given Id.
751     *
752     * @param t SharkTransaction.
753     * @param procId Id of process instance.
754     * @return XPDL process definition Id for the given process instance.
755     * @throws BaseException If something unexpected happens.
756     */
757    String getProcessDefinitionId (SharkTransaction t,String procId) throws BaseException;
758
759    /**
760     * Returns string representing the XPDL name of variable that can
761     * be determined by the given parameters. If there is no such variable,
762     * BaseException will be thrown, and if this variable is the FormalParameter
763     * of the process, he variableId parameter will be returned.
764     *
765     * @param mgrName process manager name.
766     * @param variableId Id of XPDL variable definition.
767     * @return XPDL name of variable.
768     * @throws BaseException If something unexpected happens.
769     */
770    String getDefVariableName (String mgrName,String variableId) throws BaseException;
771
772    /**
773     * Returns string representing the XPDL name of variable that can
774     * be determined by the given parameters. If there is no such variable,
775     * BaseException will be thrown, and if this variable is the FormalParameter
776     * of the process, the variableId parameter will be returned.
777     *
778     * @param t SharkTransaction.
779     * @param mgrName process manager name.
780     * @param variableId Id of XPDL variable definition.
781     * @return XPDL name of variable.
782     * @throws BaseException If something unexpected happens.