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: * @(#)Interface.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 java.net.URI;
033:
034: /**
035: * API for WSDL 2.0 Interface Component.
036: *
037: * @author ApiGen AX.00
038: */
039: public interface Interface extends ExtensibleDocumentedComponent {
040: /**
041: * Get target namespace of this binding.
042: *
043: * @return Target namespace of this binding
044: */
045: String getTargetNamespace();
046:
047: /**
048: * Get local name of this interface component.
049: *
050: * @return Local name of this interface component
051: */
052: String getName();
053:
054: /**
055: * Set local name of this interface component.
056: *
057: * @param theName Local name of this interface component
058: */
059: void setName(String theName);
060:
061: /**
062: * Get qualified name of this component.
063: *
064: * @return Qualified name of this component
065: */
066: QName getQName();
067:
068: /**
069: * Get the number of Interface items in interfaces.
070: *
071: * @return The number of Interface items in interfaces
072: */
073: int getInterfacesLength();
074:
075: /**
076: * Get interfaces this interface extends, if any by indexed position.
077: *
078: * @param index Indexed position value 0..length-1
079: * @return Interfaces this interface extends, if any at given
080: * <code>index</code> position.
081: */
082: Interface getInterface(int index);
083:
084: /**
085: * Set interfaces this interface extends, if any by indexed position.
086: *
087: * @param index Indexed position value (0..length-1) of the item to set
088: * @param theInterface Item to add at position <code>index</code>.
089: */
090: void setInterface(int index, Interface theInterface);
091:
092: /**
093: * Append an item to interfaces this interface extends, if any.
094: *
095: * @param theInterface Item to append to interfaces
096: */
097: void appendInterface(Interface theInterface);
098:
099: /**
100: * Remove interfaces this interface extends, if any by index position.
101: *
102: * @param index The index position of the interface to remove
103: * @return The Interface removed, if any.
104: */
105: Interface removeInterface(int index);
106:
107: /**
108: * Get the number of InterfaceFault items in faults.
109: *
110: * @return The number of InterfaceFault items in faults
111: */
112: int getFaultsLength();
113:
114: /**
115: * Get faults that may occur executing operations of this interface by
116: * indexed position.
117: *
118: * @param index Indexed position value 0..length-1
119: * @return Faults that may occur executing operations of this interface
120: * at given <code>index</code> position.
121: */
122: InterfaceFault getFault(int index);
123:
124: /**
125: * Set faults that may occur executing operations of this interface by
126: * indexed position.
127: *
128: * @param index Indexed position value (0..length-1) of the item to set
129: * @param theFault Item to add at position <code>index</code>.
130: */
131: void setFault(int index, InterfaceFault theFault);
132:
133: /**
134: * Append an item to faults that may occur executing operations of this
135: * interface.
136: *
137: * @param theFault Item to append to faults
138: */
139: void appendFault(InterfaceFault theFault);
140:
141: /**
142: * Remove faults that may occur executing operations of this interface by
143: * index position.
144: *
145: * @param index The index position of the fault to remove
146: * @return The InterfaceFault removed, if any.
147: */
148: InterfaceFault removeFault(int index);
149:
150: /**
151: * Get the default styles used to construct the {element} properties of
152: * {message references} of all operations contained in this interface.
153: *
154: * @return The default styles used to construct the {element} properties
155: * of {message references} of all operations contained in this interface
156: */
157: URI[] getStyleDefault();
158:
159: /**
160: * Set the default styles used to construct the {element} properties of
161: * {message references} of all operations contained in this interface.
162: *
163: * @param theStyleDefault The default styles used to construct the
164: * {element} properties of {message references} of all operations
165: * contained in this interface
166: */
167: void setStyleDefault(URI[] theStyleDefault);
168:
169: /**
170: * Get the number of InterfaceOperation items in operations.
171: *
172: * @return The number of InterfaceOperation items in operations
173: */
174: int getOperationsLength();
175:
176: /**
177: * Get operations defined by this interface only by indexed position.
178: *
179: * @param index Indexed position value 0..length-1
180: * @return operations defined by this interface only at given
181: * <code>index</code> position.
182: */
183: InterfaceOperation getOperation(int index);
184:
185: /**
186: * Set operations defined by this interface only by indexed position.
187: *
188: * @param index Indexed position value (0..length-1) of the item to set
189: * @param theOperation Item to add at position <code>index</code>.
190: */
191: void setOperation(int index, InterfaceOperation theOperation);
192:
193: /**
194: * Append an item to operations defined by this interface only.
195: *
196: * @param theOperation Item to append to operations
197: */
198: void appendOperation(InterfaceOperation theOperation);
199:
200: /**
201: * Remove operations defined by this interface only by index position.
202: *
203: * @param index The index position of the operation to remove
204: * @return The InterfaceOperation removed, if any.
205: */
206: InterfaceOperation removeOperation(int index);
207:
208: /**
209: * Get the interfaces extended by this interface, including those
210: * extended by this interface's super-interfaces.
211: *
212: * @return Extended interfaces, including those extended by this
213: * interface's super-interfaces
214: */
215: Interface[] getExtendedInterfaces();
216:
217: /**
218: * Get the operations defined by this interface, and all its
219: * super-interfaces.
220: *
221: * @return Operations defined by this interface, and all super-interfaces
222: */
223: InterfaceOperation[] getExtendedOperations();
224:
225: /**
226: * Create a new operation, appending it to this interface's operations
227: * list.
228: *
229: * @return Newly created operation, appended to the operations list.
230: */
231: InterfaceOperation addNewOperation();
232:
233: /**
234: * Create a new fault, and append it to this interface's faults list.
235: *
236: * @param name Name of the new fault
237: * @return Newly created interface, appended to the faults list.
238: */
239: InterfaceFault addNewFault(String name);
240: }
241:
242: // End-of-file: Interface.java
|