annotate WebServiceExtensionsV1.1/WebServiceToolWorkflow_REST_SOAP/lib/SAWADLParser/src/javax/wadls/Method.java @ 0:049760c677de default tip

Galaxy WSExtensions added successfully
author uga-galaxy-group
date Tue, 05 Jul 2011 19:34:18 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
1 /*
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
2 * (c) Copyright IBM Corp 2001, 2005
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
3 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
4
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
5 package javax.wadls;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
6
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
7 import java.util.List;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
8 import java.util.Map;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
9 import org.w3c.dom.Element;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
10
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
11
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
12 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
13 * This interface represents a WSDL operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
14 * It includes information on input, output and fault
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
15 * messages associated with usage of the operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
16 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
17 * @author Zixin Wu (wuzixin@uga.edu)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
18 * @author Paul Fremantle (pzf@us.ibm.com)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
19 * @author Nirmal Mukhi (nmukhi@us.ibm.com)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
20 * @author Matthew J. Duftler (duftler@us.ibm.com)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
21 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
22 public interface Method extends java.io.Serializable, ModelReferenceExtensible
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
23 {
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
24
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
25 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
26 * Set the precondition of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
27 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
28 * @param preCondition the desired precondition
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
29 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
30 public void setPreCondition(PreCondition preCondition);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
31
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
32 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
33 * Get the precondition of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
34 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
35 * @return the precondition
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
36 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
37 public PreCondition getPreCondition();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
38
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
39 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
40 * Set the effect of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
41 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
42 * @param effect the desired effect
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
43 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
44 public void setEffect(Effect effect);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
45
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
46 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
47 * Get the effect of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
48 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
49 * @return The effect
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
50 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
51 public Effect getEffect();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
52
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
53 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
54 * Set the name of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
55 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
56 * @param name the desired name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
57 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
58 public void setName(String name);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
59
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
60 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
61 * Get the name of this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
62 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
63 * @return the operation name
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
64 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
65 public String getName();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
66
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
67 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
68 * Set the input message specification for this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
69 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
70 * @param input the new input message
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
71 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
72 public void setRequest(Request request);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
73
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
74 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
75 * Get the input message specification for this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
76 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
77 * @return the input message
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
78 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
79 public Request getRequest();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
80
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
81 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
82 * Set the output message specification for this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
83 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
84 * @param output the new output message
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
85 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
86 public void setResponse(Response response);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
87
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
88 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
89 * Get the output message specification for this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
90 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
91 * @return the output message specification for the operation
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
92 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
93 public Response getResponse();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
94
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
95
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
96 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
97 * Set the style for this operation (request-response,
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
98 * one way, solicit-response or notification).
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
99 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
100 * @param style the new operation style
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
101
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
102 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
103 * Set the parameter ordering for a request-response,
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
104 * or solicit-response operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
105 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
106 * @param parameterOrder a list of named parameters
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
107 * containing the part names to reflect the desired
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
108 * order of parameters for RPC-style operations
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
109 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
110 public void setParameterOrdering(List parameterOrder);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
111
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
112 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
113 * Get the parameter ordering for this operation.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
114 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
115 * @return the parameter ordering, a list consisting
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
116 * of message part names
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
117 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
118 public List getParameterOrdering();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
119
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
120 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
121 * Set the documentation element for this document. This dependency
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
122 * on org.w3c.dom.Element should eventually be removed when a more
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
123 * appropriate way of representing this information is employed.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
124 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
125 * @param docEl the documentation element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
126 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
127 public void setDocumentationElement(Element docEl);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
128
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
129 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
130 * Get the documentation element. This dependency on org.w3c.dom.Element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
131 * should eventually be removed when a more appropriate way of
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
132 * representing this information is employed.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
133 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
134 * @return the documentation element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
135 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
136 public Element getDocumentationElement();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
137
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
138 public void setUndefined(boolean isUndefined);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
139
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
140 public boolean isUndefined();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
141
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
142 }