View Javadoc

1   /*
2    * Copyright (c) 2005, The K-Wf Grid Consortium
3    * Fraunhofer Institute for Computer Architecture and Software Technology
4    * See http://www.kwfgrid.eu and http://www.first.fraunhofer.de for more details.
5    */
6   package net.kwfgrid.gworkflowdl.protocol.calls;
7   
8   import net.kwfgrid.gworkflowdl.protocol.structure.*;
9   import net.kwfgrid.gworkflowdl.structure.OperationCandidate;
10  
11  import java.io.IOException;
12  
13  import org.xmlpull.v1.XmlSerializer;
14  
15  /***
16     Interface for a MethodCallMarshaller. Marshals all method calls to workflow structure.
17   */
18  public interface IMethodCallMarshaller {
19      void marshalGenericPropertiesSetProperty(XmlSerializer serializer, ProtocolProperties properties, int index, ProtocolProperty property) 
20  	throws IOException, UnsupportedOperationException, IndexOutOfBoundsException;
21  
22      void marshalGenericPropertiesPut(XmlSerializer serializer, ProtocolProperties properties, String key, String value) 
23  	throws IOException, UnsupportedOperationException;
24  
25      void marshalGenericPropertiesSetProperties(XmlSerializer serializer, ProtocolProperties properties, ProtocolProperty[] newprops)
26  	throws IOException, UnsupportedOperationException;
27  
28      void marshalGenericPropertiesRemove(XmlSerializer serializer, ProtocolProperties properties, String key)
29  	throws IOException, UnsupportedOperationException;
30  
31      void marshalPropertySetKey(XmlSerializer serializer, ProtocolProperty prop, String key) 
32  	throws IOException, UnsupportedOperationException;
33  
34      void marshalPropertySetValue(XmlSerializer serializer, ProtocolProperty prop, String value) 
35  	throws IOException, UnsupportedOperationException;
36  
37      void marshalOwlsAddOwl(XmlSerializer serializer, ProtocolOwls o, String owl) 
38  	throws IOException, UnsupportedOperationException;
39  
40      void marshalOwlsRemoveOwl(XmlSerializer serializer, ProtocolOwls o, int i) 
41  	throws IOException, UnsupportedOperationException;
42  
43      void marshalOwlsSetOwls(XmlSerializer serializer, ProtocolOwls o, String[] owls) 
44  	throws IOException, UnsupportedOperationException;
45  
46      void marshalWorkflowFromXML(XmlSerializer serializer, ProtocolWorkflow wf, String xml) 
47  	throws IOException, UnsupportedOperationException;
48  
49      /*
50      void marshalWorkflowSetID(XmlSerializer serializer, ProtocolWorkflow wf, String ID) 
51  	throws IOException, UnsupportedOperationException;
52      */
53  
54      void marshalWorkflowSetDescription(XmlSerializer serializer, ProtocolWorkflow wf, String description) 
55  	throws IOException, UnsupportedOperationException;
56  
57      void marshalWorkflowAddPlace(XmlSerializer serializer, ProtocolWorkflow wf, ProtocolPlace place) 
58  	throws IOException, UnsupportedOperationException;
59  
60      void marshalWorkflowRemovePlace(XmlSerializer serializer, ProtocolWorkflow wf, int i) 
61  	throws IOException, UnsupportedOperationException;
62  
63      void marshalWorkflowSetPlaces(XmlSerializer serializer, ProtocolWorkflow wf, ProtocolPlace[] places) 
64  	throws IOException, UnsupportedOperationException;
65  
66      void marshalWorkflowAddTransition(XmlSerializer serializer, ProtocolWorkflow wf, ProtocolTransition transition) 
67  	throws IOException, UnsupportedOperationException;
68  
69      void marshalWorkflowRemoveTransition(XmlSerializer serializer, ProtocolWorkflow wf, int i) 
70  	throws IOException, UnsupportedOperationException;
71  
72      void marshalWorkflowSetTransitions(XmlSerializer serializer, ProtocolWorkflow wf, ProtocolTransition[] transition) 
73  	throws IOException, UnsupportedOperationException;
74  
75      void marshalWorkflowSetProperties(XmlSerializer serializer, ProtocolWorkflow wf, ProtocolProperties op) 
76  	throws IOException, UnsupportedOperationException;
77  
78      void marshalPlaceSetID(XmlSerializer serializer, ProtocolPlace p, String newid) 
79  	throws IOException, UnsupportedOperationException;
80  
81      void marshalPlaceSetDescription(XmlSerializer serializer, ProtocolPlace p, String description) 
82  	throws IOException, UnsupportedOperationException;
83  
84      void marshalPlaceSetTokenType(XmlSerializer serializer, ProtocolPlace p, String type) 
85  	throws IOException, UnsupportedOperationException;
86  
87      void marshalPlaceAddToken(XmlSerializer serializer, ProtocolPlace p, ProtocolToken token) 
88  	throws IOException, UnsupportedOperationException;
89  
90      void marshalPlaceSetTokens(XmlSerializer serializer, ProtocolPlace p, ProtocolToken[] ts)
91      throws IOException, UnsupportedOperationException;
92  
93      void marshalPlaceRemoveToken(XmlSerializer serializer, ProtocolPlace p, ProtocolToken token)
94  	throws IOException, UnsupportedOperationException;
95  
96      void marshalPlaceRemoveToken(XmlSerializer serializer, ProtocolPlace p, int index) 
97  	throws IOException, UnsupportedOperationException;
98  
99      void marshalPlaceSetCapacity(XmlSerializer serializer, ProtocolPlace p, int capacity) 
100 	throws IOException, UnsupportedOperationException;
101 
102     void marshalPlaceRemoveAllTokens(XmlSerializer serializer, ProtocolPlace p) 
103 	throws IOException, UnsupportedOperationException;
104 
105     void marshalPlaceSetProperties(XmlSerializer serializer, ProtocolPlace p, ProtocolProperties op) 
106 	throws IOException, UnsupportedOperationException;
107 
108     void marshalTokenSetID(XmlSerializer serializer, ProtocolToken t, String newid)
109 	throws IOException, UnsupportedOperationException;
110 
111     void marshalTokenSetProperties(XmlSerializer serializer, ProtocolToken token, ProtocolProperties properties)
112     throws IOException, UnsupportedOperationException;
113 
114     void marshalTokenSetControl(XmlSerializer serializer, ProtocolToken token, Boolean control)
115     throws IOException, UnsupportedOperationException;
116 
117     void marshalTokenSetData(XmlSerializer serializer, ProtocolToken token, ProtocolData data)
118     throws IOException, UnsupportedOperationException;
119 
120     void marshalDataFromXML(XmlSerializer serializer, ProtocolData data, String xml)
121     throws IOException, UnsupportedOperationException;
122 
123     void marshalDataSet(XmlSerializer serializer, ProtocolData data, Object content)
124     throws IOException, UnsupportedOperationException;
125 
126     void marshalTransitionSetID(XmlSerializer serializer, ProtocolTransition t, String newid)
127 	throws IOException, UnsupportedOperationException;
128 
129     void marshalTransitionSetDescription(XmlSerializer serializer, ProtocolTransition t, String description) 
130 	throws IOException, UnsupportedOperationException;
131 
132     void marshalTransitionAddReadEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
133     throws IOException, UnsupportedOperationException;
134 
135     void marshalTransitionAddInEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
136 	throws IOException, UnsupportedOperationException;
137 
138     void marshalTransitionRemoveReadEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
139     throws IOException, UnsupportedOperationException;
140 
141     void marshalTransitionRemoveInEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge) 
142 	throws IOException, UnsupportedOperationException;
143 
144     void marshalTransitionSetReadEdges(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge[] edges) 
145 	throws IOException, UnsupportedOperationException;
146 
147     void marshalTransitionSetInEdges(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge[] edges)
148 	throws IOException, UnsupportedOperationException;
149 
150     void marshalTransitionAddWriteEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
151     throws IOException, UnsupportedOperationException;
152 
153     void marshalTransitionAddOutEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
154 	throws IOException, UnsupportedOperationException;
155 
156     void marshalTransitionRemoveWriteEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
157     throws IOException, UnsupportedOperationException;
158 
159     void marshalTransitionRemoveOutEdge(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge edge)
160 	throws IOException, UnsupportedOperationException;
161 
162     void marshalTransitionSetWriteEdges(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge[] edges) 
163 	throws IOException, UnsupportedOperationException;
164 
165     void marshalTransitionSetOutEdges(XmlSerializer serializer, ProtocolTransition t, ProtocolEdge[] edges)
166 	throws IOException, UnsupportedOperationException;
167 
168     void marshalTransitionAddCondition(XmlSerializer serializer, ProtocolTransition t, String condition) 
169 	throws IOException, UnsupportedOperationException;
170 
171     void marshalTransitionRemoveCondition(XmlSerializer serializer, ProtocolTransition t, int index) 
172 	throws IOException, UnsupportedOperationException;
173 
174     void marshalTransitionSetConditions(XmlSerializer serializer, ProtocolTransition t, String[] conditions) 
175 	throws IOException, UnsupportedOperationException;
176 
177     void marshalTransitionSetOperation(XmlSerializer serializer, ProtocolTransition t, ProtocolOperation op) 
178 	throws IOException, UnsupportedOperationException;
179 
180     void marshalTransitionSetProperties(XmlSerializer serializer, ProtocolTransition t, ProtocolProperties op) 
181 	throws IOException, UnsupportedOperationException;
182 
183     void marshalEdgeSetExpression(XmlSerializer serializer, ProtocolEdge e, String newexpression) 
184 	throws IOException, UnsupportedOperationException;
185 
186     void marshalEdgeSetPlace(XmlSerializer serializer, ProtocolEdge e, ProtocolPlace place) 
187 	throws IOException, UnsupportedOperationException;
188 
189     // operation
190     void marshalOperationSetOperationClass(XmlSerializer serializer, ProtocolOperation o, ProtocolOperationClass co)
191 	throws IOException, UnsupportedOperationException;
192 
193     // operationClass
194     void marshalOperationClassSetName(XmlSerializer serializer, ProtocolOperationClass operation, String name)
195     throws IOException, UnsupportedOperationException;
196 
197     void marshalOperationClassSetOperationCandidates(XmlSerializer serializer, ProtocolOperationClass poc, OperationCandidate[] pocs)
198 	throws IOException, UnsupportedOperationException;
199 
200     void marshalOperationClassRemoveOperationCandidate(XmlSerializer serializer, ProtocolOperationClass poc, int i)
201 	throws IOException, UnsupportedOperationException;
202 
203     void marshalOperationClassAddOperationCandidate(XmlSerializer serializer, ProtocolOperationClass poc, OperationCandidate o)
204 	throws IOException, UnsupportedOperationException;
205 
206     // operationCandidate
207     void marshalOperationCandidateSetType(XmlSerializer serializer, ProtocolOperationCandidate poc, String name)
208 	throws IOException, UnsupportedOperationException;
209 
210     void marshalOperationCandidateSetOperationName(XmlSerializer serializer, ProtocolOperationCandidate poc, String name)
211 	throws IOException, UnsupportedOperationException;
212 
213     void marshalOperationCandidateSetResourceName(XmlSerializer serializer, ProtocolOperationCandidate poc, String name)
214 	throws IOException, UnsupportedOperationException;
215 
216     void marshalOperationCandidateSetQuality(XmlSerializer serializer, ProtocolOperationCandidate oc, float q)
217     throws IOException, UnsupportedOperationException;
218 
219     void marshalOperationCandidateSetSelected(XmlSerializer serializer, ProtocolOperationCandidate poc, boolean selected)
220 	throws IOException, UnsupportedOperationException;
221 
222     // commandLineOperation -> operationCandidate
223 
224     // wsOperation -> operationCandidate
225 
226 }