KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > enhydra > shark > api > internal > interoperability > WfEngineInteroperability


1 /* WfEngineInteroperability.java */
2 package org.enhydra.shark.api.internal.interoperability;
3
4 import java.util.Map JavaDoc;
5
6 import org.enhydra.shark.api.RootException;
7 import org.enhydra.shark.api.SharkTransaction;
8 import org.enhydra.shark.api.internal.working.CallbackUtilities;
9
10 /**
11  * WfEngineInteroperability
12  *
13  * @author V.Puskas
14  * @version 0.1
15  */

16 public interface WfEngineInteroperability {
17    /**
18     * Used to configure component.
19     */

20    void configure(CallbackUtilities cus) throws RootException;
21
22    /**
23     * @param st transaction
24     * @param remoteEngine containing uri of the remote service
25     * @param processInstanceId id of the local process
26     * @param workitemId assignment id of the local activity
27     * @param parameters map of parameters to pass to the remote engine
28     * @return remote instance uri
29     * @throws InteroperabilityException thrown on failure to complete
30     * the task
31     */

32    String JavaDoc start(SharkTransaction st,
33                 String JavaDoc remoteEngine,
34                 String JavaDoc processInstanceId,
35                 String JavaDoc workitemId,
36                 boolean isSynchronized,
37                 Map JavaDoc parameters) throws InteroperabilityException;
38
39    /**
40     * @param st
41     * @param remoteInstanceUri
42     * @param processInstanceId
43     * @param workitemId
44     * @throws InteroperabilityException
45     */

46    void suspend(SharkTransaction st,
47                 String JavaDoc remoteInstanceUri,
48                 String JavaDoc processInstanceId,
49                 String JavaDoc workitemId) throws InteroperabilityException;
50
51    /**
52     * @param st
53     * @param remoteInstanceUri
54     * @param processInstanceId
55     * @param workitemId
56     * @throws InteroperabilityException
57     */

58    void resume(SharkTransaction st,
59                String JavaDoc remoteInstanceUri,
60                String JavaDoc processInstanceId,
61                String JavaDoc workitemId) throws InteroperabilityException;
62
63    /**
64     * @param st
65     * @param remoteInstanceUri
66     * @param processInstanceId
67     * @param workitemId
68     * @throws InteroperabilityException
69     */

70    void terminate(SharkTransaction st,
71                   String JavaDoc remoteInstanceUri,
72                   String JavaDoc processInstanceId,
73                   String JavaDoc workitemId) throws InteroperabilityException;
74
75    /**
76     * @param st
77     * @param remoteInstanceUri
78     * @param processInstanceId
79     * @param workitemId
80     * @throws InteroperabilityException
81     */

82    void abort(SharkTransaction st,
83               String JavaDoc remoteInstanceUri,
84               String JavaDoc processInstanceId,
85               String JavaDoc workitemId) throws InteroperabilityException;
86
87    /**
88     * @param st
89     * @param processInstanceId
90     * @param workitemId
91     * @param parameters
92     * @return @throws BaseException
93     * @throws InteroperabilityException
94     */

95    Map JavaDoc parseOutParams(SharkTransaction st,
96                       String JavaDoc processInstanceId,
97                       String JavaDoc workitemId,
98                       Map JavaDoc parameters,
99                       Map JavaDoc cSig) throws InteroperabilityException;
100 }
Popular Tags