View Javadoc

1   /*
2    * $Id: Invoke.java,v 1.1 2004/12/15 14:18:11 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.activity;
11  
12  import java.util.List;
13  
14  import javax.xml.namespace.QName;
15  
16  import bexee.model.elements.CatchFault;
17  import bexee.model.elements.Correlations;
18  import bexee.model.elements.PartnerLink;
19  import bexee.model.elements.Variable;
20  
21  /***
22   * Representation of a BPEL Invoke activity.
23   * 
24   * @version $Revision: 1.1 $, $Date: 2004/12/15 14:18:11 $
25   * @author Patric Fornasier
26   * @author Pawel Kowalski
27   */
28  public interface Invoke extends Activity {
29  
30      //  **************************************************/
31      //  xml attributes
32      // **************************************************/
33  
34      /***
35       * Set the PartnerLink of this Invoke.
36       * 
37       * @param partnerLink
38       */
39      public void setPartnerLink(PartnerLink partnerLink);
40  
41      /***
42       * Get the PartnerLink of this Invoke.
43       * 
44       * @return
45       */
46      public PartnerLink getPartnerLink();
47  
48      /***
49       * Set the PortType QName of this Invoke.
50       * 
51       * @param portType
52       */
53      public void setPortType(QName portType);
54  
55      /***
56       * Get the PortType QName of this Invoke.
57       * 
58       * @return
59       */
60      public QName getPortType();
61  
62      /***
63       * Set the operation to be called by this Invoke.
64       * 
65       * @param operation
66       */
67      public void setOperation(String operation);
68  
69      /***
70       * Get the operation to be called by this Invoke.
71       * 
72       * @return
73       */
74      public String getOperation();
75  
76      /***
77       * Set the InputVariable of this Invoke.
78       * 
79       * @param inputVariable
80       */
81      public void setInputVariable(Variable inputVariable);
82  
83      /***
84       * Get the InputVariable of this Invoke.
85       * 
86       * @return
87       */
88      public Variable getInputVariable();
89  
90      /***
91       * Set the OutputVariable of this Invoke.
92       * 
93       * @param outputVariable
94       */
95      public void setOutputVariable(Variable outputVariable);
96  
97      /***
98       * Get the OutputVariable of this Invoke.
99       * 
100      * @return
101      */
102     public Variable getOutputVariable();
103 
104     //***************************************************/
105     // xml elements
106     //***************************************************/
107 
108     /***
109      * Set the Correlations of this Invoke.
110      * 
111      * @param correlations
112      */
113     public void setCorrelations(Correlations correlations);
114 
115     /***
116      * Get the Correlations of this Invoke.
117      * 
118      * @return
119      */
120     public Correlations getCorrelations();
121 
122     /***
123      * Add a Catch to this Invoke.
124      * 
125      * @param catchFault
126      */
127     public void addCatchFault(CatchFault catchFault);
128 
129     /***
130      * Set all Catch elements of this Invoke.
131      * 
132      * @param catchFaults
133      */
134     public void setCatchFaults(List catchFaults);
135 
136     /***
137      * Get all Catch elements of this Invoke.
138      * 
139      * @return
140      */
141     public List getCatchFaults();
142 
143     /***
144      * Set the CatchAll of this Invoke.
145      * 
146      * @param catchAll
147      */
148     public void setCatchAll(CatchAll catchAll);
149 
150     /***
151      * Get the CatchAll of this Invoke.
152      * 
153      * @return
154      */
155     public CatchAll getCatchAll();
156 
157     /***
158      * Set the CompensationHandler of this Invoke.
159      * 
160      * @param compensationHandler
161      */
162     public void setCompensationHandler(CompensationHandler compensationHandler);
163 
164     /***
165      * Get the CompensationHandler of this Invoke.
166      * 
167      * @return
168      */
169     public CompensationHandler getCompensationHandler();
170 
171     //***************************************************/
172     // helper methods
173     //***************************************************/
174 
175     /***
176      * Is this Invoke synchronous.
177      * 
178      * @return
179      */
180     public boolean isSynchronous();
181 
182 }