View Javadoc

1   /*
2    * $Id: Process.java,v 1.1 2004/12/15 14:18:09 patforna Exp $
3    *
4    * Copyright (c) 2004 Patric Fornasier, Pawel Kowalski
5    * Berne University of Applied Sciences
6    * School of Engineering and Information Technology
7    * All rights reserved.
8    */
9   
10  package bexee.model.process;
11  
12  import bexee.model.BPELElement;
13  import bexee.model.activity.Activity;
14  import bexee.model.activity.CompensationHandler;
15  import bexee.model.elements.CorrelationSets;
16  import bexee.model.elements.EventHandlers;
17  import bexee.model.elements.FaultHandlers;
18  import bexee.model.elements.PartnerLinks;
19  import bexee.model.elements.Partners;
20  import bexee.model.elements.Variables;
21  
22  /***
23   * This is a representation of a BPEL process element from a BPEL document.
24   * Usually an instance of this class will be embedded in a BPELProcess instance
25   * containing additional information about a business process.
26   * 
27   * @version $Revision: 1.1 $, $Date: 2004/12/15 14:18:09 $
28   * @author Patric Fornasier
29   * @author Pawel Kowalski
30   */
31  public interface Process extends BPELElement {
32  
33      /***
34       * Default query language.
35       */
36      public static final String DEFAULT_QUERY_LANGUAGE = "http://www.w3.org/TR/1999/REC-xpath-19991116";
37  
38      /***
39       * Default expression language.
40       */
41      public static final String DEFAULT_EXPRESSION_LANGUAGE = "http://www.w3.org/TR/1999/REC-xpath-19991116";
42  
43      /***
44       * Default suppress join failure value.
45       */
46      public static final boolean DEFAULT_SUPPRESS_JOIN_FAILURE = false;
47  
48      /***
49       * Default instance compensation value.
50       */
51      public static final boolean DEFAULT_ENABLE_INSTANCE_COMPENSATION = false;
52  
53      /***
54       * Default value for the abstractness of a BPEL process.
55       */
56      public static final boolean DEFAULT_ABSTRACT_PROCESS = false;
57  
58      //***************************************************/
59      // xml attributes
60      //***************************************************/
61  
62      /***
63       * Set the name of this process.
64       * 
65       * @param name
66       */
67      public void setName(String name);
68  
69      /***
70       * Get the name of this process.
71       * 
72       * @return
73       */
74      public String getName();
75  
76      /***
77       * Set the targetNamespace of this process.
78       * 
79       * @param targetNamespace
80       */
81      public void setTargetNamespace(String targetNamespace);
82  
83      /***
84       * Get the targetNamespace of this process.
85       * 
86       * @return
87       */
88      public String getTargetNamespace();
89  
90      /***
91       * Set the queryLanguage of this process.
92       * 
93       * @param queryLanguage
94       */
95      public void setQueryLanguage(String queryLanguage);
96  
97      /***
98       * Get the queryLanguage of this process.
99       * 
100      * @return
101      */
102     public String getQueryLanguage();
103 
104     /***
105      * Set the expressionLanguage of this process.
106      * 
107      * @param expressionLanguage
108      */
109     public void setExpressionLanguage(String expressionLanguage);
110 
111     /***
112      * Get the expressionLanguage of this process.
113      * 
114      * @return
115      */
116     public String getExpressionLanguage();
117 
118     /***
119      * Set the suppressJoinFailure property of this process.
120      * 
121      * @param suppressJoinFailure
122      */
123     public void setSuppressJoinFailure(boolean suppressJoinFailure);
124 
125     /***
126      * Are join failures suppressed in this process.
127      * 
128      * @return
129      */
130     public boolean isSuppressJoinFailure();
131 
132     /***
133      * Set the EnableInstanceCompensation property of this process.
134      * 
135      * @param isInstanceCompensable
136      */
137     public void setEnableInstanceCompensation(boolean isInstanceCompensable);
138 
139     /***
140      * Get the EnableInstanceCompensation property of this process.
141      * 
142      * @return
143      */
144     public boolean isInstanceCompensable();
145 
146     /***
147      * Set a property indicating whether this process is abstract.
148      * 
149      * @param isAbstractProcess
150      */
151     public void setAbstractProcess(boolean isAbstractProcess);
152 
153     /***
154      * Is this an abstract process.
155      * 
156      * @return
157      */
158     public boolean isAbstractProcess();
159 
160     //***************************************************/
161     // xml elements
162     //***************************************************/
163 
164     /***
165      * Set the PartnerLinks of this process.
166      * 
167      * @param partnerLinks
168      */
169     public void setPartnerLinks(PartnerLinks partnerLinks);
170 
171     /***
172      * Get the PartnerLinks of this process.
173      * 
174      * @return
175      */
176     public PartnerLinks getPartnerLinks();
177 
178     /***
179      * Set the Partners of this process.
180      * 
181      * @param partners
182      */
183     public void setPartners(Partners partners);
184 
185     /***
186      * Get the Partners of this process.
187      * 
188      * @return
189      */
190     public Partners getPartners();
191 
192     /***
193      * Set the Variables of this process.
194      * 
195      * @param variables
196      */
197     public void setVariables(Variables variables);
198 
199     /***
200      * Get the Variables of this process.
201      * 
202      * @return
203      */
204     public Variables getVariables();
205 
206     /***
207      * Set the CorrelationSets of this process.
208      * 
209      * @param correlationSets
210      */
211     public void setCorrelationSets(CorrelationSets correlationSets);
212 
213     /***
214      * Get the CorrelationSets of this process.
215      * 
216      * @return
217      */
218     public CorrelationSets getCorrelationSets();
219 
220     /***
221      * Set the FaultHandlers of this process.
222      * 
223      * @param faultHandlers
224      */
225     public void setFaultHandlers(FaultHandlers faultHandlers);
226 
227     /***
228      * Get the FaultHandlers of this process.
229      * 
230      * @return
231      */
232     public FaultHandlers getFaultHandlers();
233 
234     /***
235      * Set the CompensationHandler of this process.
236      * 
237      * @param handler
238      */
239     public void setCompensationHandler(CompensationHandler handler);
240 
241     /***
242      * Get the CompensationHandler of this process.
243      * 
244      * @return
245      */
246     public CompensationHandler getCompensationHandler();
247 
248     /***
249      * Set the EventHandlers of this process.
250      * 
251      * @param handlers
252      */
253     public void setEventHandlers(EventHandlers handlers);
254 
255     /***
256      * Get the EventHandlers of this process.
257      * 
258      * @return
259      */
260     public EventHandlers getEventHandlers();
261 
262     /***
263      * Set the root activity of this process.
264      * 
265      * @param activity
266      */
267     public void setActivity(Activity activity);
268 
269     /***
270      * Get the root activity of this process.
271      * 
272      * @return
273      */
274     public Activity getActivity();
275 
276 }