001: /*
002: * BEGIN_HEADER - DO NOT EDIT
003: *
004: * The contents of this file are subject to the terms
005: * of the Common Development and Distribution License
006: * (the "License"). You may not use this file except
007: * in compliance with the License.
008: *
009: * You can obtain a copy of the license at
010: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
011: * See the License for the specific language governing
012: * permissions and limitations under the License.
013: *
014: * When distributing Covered Code, include this CDDL
015: * HEADER in each file and include the License file at
016: * https://open-esb.dev.java.net/public/CDDLv1.0.html.
017: * If applicable add the following below this CDDL HEADER,
018: * with the fields enclosed by brackets "[]" replaced with
019: * your own identifying information: Portions Copyright
020: * [year] [name of copyright owner]
021: */
022:
023: /*
024: * @(#)InterfaceOperation.java
025: * Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
026: *
027: * END_HEADER - DO NOT EDIT
028: */
029: package com.sun.jbi.wsdl2;
030:
031: import javax.xml.namespace.QName;
032: import org.w3c.dom.DocumentFragment;
033:
034: /**
035: * API for WSDL 2.0 interface operation component.
036: *
037: * @author ApiGen AX.00
038: */
039: public interface InterfaceOperation extends
040: ExtensibleDocumentedComponent {
041: /**
042: * Get name of this interface operation component.
043: *
044: * @return Name of this interface operation component
045: */
046: String getName();
047:
048: /**
049: * Set name of this interface operation component.
050: *
051: * @param theName Name of this interface operation component
052: */
053: void setName(String theName);
054:
055: /**
056: * Get message exchange pattern URI for this operation.
057: *
058: * @return Message exchange pattern URI for this operation
059: */
060: String getPattern();
061:
062: /**
063: * Set message exchange pattern URI for this operation.
064: *
065: * @param thePattern Message exchange pattern URI for this operation
066: */
067: void setPattern(String thePattern);
068:
069: /**
070: * Get a URI identifying the message construction rules for a message
071: * reference.
072: *
073: * @return A URI identifying the message construction rules for a message
074: * reference
075: */
076: String getStyle();
077:
078: /**
079: * Set a URI identifying the message construction rules for a message
080: * reference.
081: *
082: * @param theStyle A URI identifying the message construction rules for a
083: * message reference
084: */
085: void setStyle(String theStyle);
086:
087: /**
088: * Get true if the operation is safe, as defined by the W3C Web Services
089: * Architecture document.
090: *
091: * @return True if the operation is safe, as defined by the W3C Web
092: * Services Architecture document
093: */
094: boolean getSafe();
095:
096: /**
097: * Set true if the operation is safe, as defined by the W3C Web Services
098: * Architecture document.
099: *
100: * @param isSafe True if the operation is safe, as defined by the W3C Web
101: * Services Architecture document
102: */
103: void setSafe(boolean isSafe);
104:
105: /**
106: * Get the number of MessageReference items in inputs.
107: *
108: * @return The number of MessageReference items in inputs
109: */
110: int getInputsLength();
111:
112: /**
113: * Get input message references by indexed position.
114: *
115: * @param index Indexed position value 0..length-1
116: * @return Input message references at given <code>index</code> position.
117: */
118: MessageReference getInput(int index);
119:
120: /**
121: * Set input message references by indexed position.
122: *
123: * @param index Indexed position value (0..length-1) of the item to set
124: * @param theInput Item to add at position <code>index</code>.
125: */
126: void setInput(int index, MessageReference theInput);
127:
128: /**
129: * Append an item to input message references.
130: *
131: * @param theInput Item to append to inputs
132: */
133: void appendInput(MessageReference theInput);
134:
135: /**
136: * Remove input message references by index position.
137: *
138: * @param index The index position of the input to remove
139: * @return The MessageReference removed, if any.
140: */
141: MessageReference removeInput(int index);
142:
143: /**
144: * Get the number of MessageReference items in outputs.
145: *
146: * @return The number of MessageReference items in outputs
147: */
148: int getOutputsLength();
149:
150: /**
151: * Get output message references by indexed position.
152: *
153: * @param index Indexed position value 0..length-1
154: * @return Output message references at given <code>index</code>
155: * position.
156: */
157: MessageReference getOutput(int index);
158:
159: /**
160: * Set output message references by indexed position.
161: *
162: * @param index Indexed position value (0..length-1) of the item to set
163: * @param theOutput Item to add at position <code>index</code>.
164: */
165: void setOutput(int index, MessageReference theOutput);
166:
167: /**
168: * Append an item to output message references.
169: *
170: * @param theOutput Item to append to outputs
171: */
172: void appendOutput(MessageReference theOutput);
173:
174: /**
175: * Remove output message references by index position.
176: *
177: * @param index The index position of the output to remove
178: * @return The MessageReference removed, if any.
179: */
180: MessageReference removeOutput(int index);
181:
182: /**
183: * Get the number of MessageFaultReference items in inFaults.
184: *
185: * @return The number of MessageFaultReference items in inFaults
186: */
187: int getInFaultsLength();
188:
189: /**
190: * Get in fault message references by indexed position.
191: *
192: * @param index Indexed position value 0..length-1
193: * @return In fault message references at given <code>index</code>
194: * position.
195: */
196: MessageFaultReference getInFault(int index);
197:
198: /**
199: * Set in fault message references by indexed position.
200: *
201: * @param index Indexed position value (0..length-1) of the item to set
202: * @param theInFault Item to add at position <code>index</code>.
203: */
204: void setInFault(int index, MessageFaultReference theInFault);
205:
206: /**
207: * Append an item to in fault message references.
208: *
209: * @param theInFault Item to append to inFaults
210: */
211: void appendInFault(MessageFaultReference theInFault);
212:
213: /**
214: * Remove in fault message references by index position.
215: *
216: * @param index The index position of the inFault to remove
217: * @return The MessageFaultReference removed, if any.
218: */
219: MessageFaultReference removeInFault(int index);
220:
221: /**
222: * Get the number of MessageFaultReference items in outFaults.
223: *
224: * @return The number of MessageFaultReference items in outFaults
225: */
226: int getOutFaultsLength();
227:
228: /**
229: * Get out fault message references by indexed position.
230: *
231: * @param index Indexed position value 0..length-1
232: * @return Out fault message references at given <code>index</code>
233: * position.
234: */
235: MessageFaultReference getOutFault(int index);
236:
237: /**
238: * Set out fault message references by indexed position.
239: *
240: * @param index Indexed position value (0..length-1) of the item to set
241: * @param theOutFault Item to add at position <code>index</code>.
242: */
243: void setOutFault(int index, MessageFaultReference theOutFault);
244:
245: /**
246: * Append an item to out fault message references.
247: *
248: * @param theOutFault Item to append to outFaults
249: */
250: void appendOutFault(MessageFaultReference theOutFault);
251:
252: /**
253: * Remove out fault message references by index position.
254: *
255: * @param index The index position of the outFault to remove
256: * @return The MessageFaultReference removed, if any.
257: */
258: MessageFaultReference removeOutFault(int index);
259:
260: /**
261: * Get qualified name of this interface operation.
262: *
263: * @return Qualified name of this interface operation
264: */
265: QName getQualifiedName();
266:
267: /**
268: * Create a new input message reference for this operation, and append it
269: * to this operation's input list.
270: *
271: * @return The newly created input message reference.
272: */
273: MessageReference addNewInput();
274:
275: /**
276: * Create a new output message reference for this operation, and append
277: * it to this operation's output list.
278: *
279: * @return The newly created input message reference.
280: */
281: MessageReference addNewOutput();
282:
283: /**
284: * Create a new messsage in-fault reference for this operation, and
285: * append it to the operation's in-fault list.
286: *
287: * @param fault Fault referenced by the new in-fault
288: * @return The newly created in-fault reference.
289: */
290: MessageFaultReference addNewInFault(InterfaceFault fault);
291:
292: /**
293: * Create a new messsage out-fault reference for this operation, and
294: * append it to the operation's out-fault list.
295: *
296: * @param fault Fault referenced by the new out-fault
297: * @return The newly created out-fault reference.
298: */
299: MessageFaultReference addNewOutFault(InterfaceFault fault);
300:
301: /**
302: * Return this WSDL interface operation as an XML string.
303: *
304: * @return This operation, serialized as an XML string.
305: */
306: String toXmlString();
307:
308: /**
309: * Return this interface operation as a DOM document fragment. The DOM
310: * subtree is a copy; altering it will not affect this service.
311: *
312: * @return This operation, as a DOM document fragment.
313: */
314: DocumentFragment toXmlDocumentFragment();
315:
316: }
317:
318: // End-of-file: InterfaceOperation.java
|