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: * @(#)Binding.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 Binding component.
036: *
037: * @author ApiGen AX.00
038: */
039: public interface Binding 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 binding component.
049: *
050: * @return Local name of this binding component
051: */
052: String getName();
053:
054: /**
055: * Set local name of this binding component.
056: *
057: * @param theName Local name of this binding 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 interface being bound by this binding definition, if any.
070: *
071: * @return Interface being bound by this binding definition, if any
072: */
073: Interface getInterface();
074:
075: /**
076: * Set interface being bound by this binding definition, if any.
077: *
078: * @param theInterface Interface being bound by this binding definition,
079: * if any
080: */
081: void setInterface(Interface theInterface);
082:
083: /**
084: * Get the number of BindingFault items in faults.
085: *
086: * @return The number of BindingFault items in faults
087: */
088: int getFaultsLength();
089:
090: /**
091: * Get faults bound by this binding definition by indexed position.
092: *
093: * @param index Indexed position value 0..length-1
094: * @return Faults bound by this binding definition at given
095: * <code>index</code> position.
096: */
097: BindingFault getFault(int index);
098:
099: /**
100: * Set faults bound by this binding definition by indexed position.
101: *
102: * @param index Indexed position value (0..length-1) of the item to set
103: * @param theFault Item to add at position <code>index</code>.
104: */
105: void setFault(int index, BindingFault theFault);
106:
107: /**
108: * Append an item to faults bound by this binding definition.
109: *
110: * @param theFault Item to append to faults
111: */
112: void appendFault(BindingFault theFault);
113:
114: /**
115: * Remove faults bound by this binding definition by index position.
116: *
117: * @param index The index position of the fault to remove
118: * @return The BindingFault removed, if any.
119: */
120: BindingFault removeFault(int index);
121:
122: /**
123: * Get the number of BindingOperation items in operations.
124: *
125: * @return The number of BindingOperation items in operations
126: */
127: int getOperationsLength();
128:
129: /**
130: * Get named binding operations, if any by indexed position.
131: *
132: * @param index Indexed position value 0..length-1
133: * @return Named binding operations, if any at given <code>index</code>
134: * position.
135: */
136: BindingOperation getOperation(int index);
137:
138: /**
139: * Set named binding operations, if any by indexed position.
140: *
141: * @param index Indexed position value (0..length-1) of the item to set
142: * @param theOperation Item to add at position <code>index</code>.
143: */
144: void setOperation(int index, BindingOperation theOperation);
145:
146: /**
147: * Append an item to named binding operations, if any.
148: *
149: * @param theOperation Item to append to operations
150: */
151: void appendOperation(BindingOperation theOperation);
152:
153: /**
154: * Remove named binding operations, if any by index position.
155: *
156: * @param index The index position of the operation to remove
157: * @return The BindingOperation removed, if any.
158: */
159: BindingOperation removeOperation(int index);
160:
161: /**
162: * Create a new operation, appending it to this binding's operations
163: * list.
164: *
165: * @return Newly created operation, appended to this binding's operation
166: * list.
167: */
168: BindingOperation addNewOperation();
169:
170: /**
171: * Create a new binding fault, appending it to this binding's faults
172: * list.
173: *
174: * @param ref Interface fault to which the new binding fault adds binding
175: * information
176: * @return Newly created binding fault, appended to the faults list.
177: */
178: BindingFault addNewBindingFault(InterfaceFault ref);
179:
180: /**
181: * Get URI indicating the type of this binding.
182: *
183: * @return URI indicating the type of this binding
184: */
185: String getType();
186:
187: /**
188: * Set URI indicating the type of this binding
189: *
190: * @param theType URI indicating the type of this binding
191: */
192: void setType(String theType);
193:
194: /**
195: * Return this WSDL binding as an XML string.
196: *
197: * @return This binding, serialized as an XML string.
198: */
199: String toXmlString();
200:
201: /**
202: * Return this binding as a DOM document fragment. The DOM subtree is a
203: * copy; altering it will not affect this binding.
204: *
205: * @return This binding, as a DOM document fragment.
206: */
207: DocumentFragment toXmlDocumentFragment();
208:
209: }
210:
211: // End-of-file: Binding.java
|