You are viewing a plain text version of this content. The canonical link for it is here.
Posted to woden-dev@ws.apache.org by jk...@apache.org on 2007/02/06 02:28:39 UTC
svn commit: r503949 -
/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/
Author: jkaputin
Date: Mon Feb 5 17:28:38 2007
New Revision: 503949
URL: http://svn.apache.org/viewvc?view=rev&rev=503949
Log:
API javadoc improvements in the org.apache.woden.wsdl20.xml package
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingMessageReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceOperationElement.java
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java Mon Feb 5 17:28:38 2007
@@ -23,9 +23,9 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents a WSDL <binding> element.
+ * Represents the WSDL 2.0 <binding> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface BindingElement extends DocumentableElement,
NestedElement
@@ -35,53 +35,107 @@
*/
/**
- * Set the NCName that represents the <tt>name</tt> attribute of the
- * <binding> element.
+ * Set the name of this BindingElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the <binding> element.
*
- * @param name the NCName that identifies the binding.
+ * @param name the NCName that represents this binding.
*/
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this BindingElement, which consists of its
+ * local name and the targetNamespace of the parent DescriptionElement.
+ *
+ * @return the binding QName
+ */
public QName getName();
/**
- * Set the QName that represents the <tt>interface</tt> attribute of the
- * <binding> element. This associates the binding with an interface.
+ * Specify the name of the InterfaceElement referred to by this BindingElement.
+ * This corresponds to the <code>interface</code> attribute of the <binding> element.
+ *
+ * @param interfaceName the QName of the interface
+ */
+ public void setInterfaceName(QName interfaceName);
+
+ /**
+ * Return the name of the InterfaceElement referred to by this BindingElement.
+ * This corresponds to the <code>interface</code> attribute of the <binding> element.
*
- * @param qname the QName that identifies interface for this binding
+ * @return the interface QName
*/
- public void setInterfaceName(QName qname);
public QName getInterfaceName();
/**
- * Get the InterfaceElement identified by the QName specified in the
- * <tt>interface</tt> attribute of this <binding> element.
+ * Return the InterfaceElement referred to by this BindingElement.
+ * This equates to the <interface> element referred to in the <code>interface</code>
+ * attribute of the <binding> element.
+ * If this reference cannot be resolved to an InterfaceElement or if this BindingElement
+ * is a generic (interface-less) binding, this method will return null.
*
- * @return InterfaceElement the interface associated with this binding
+ * @return the InterfaceElement
*/
public InterfaceElement getInterfaceElement();
/**
- * Set the URI that represents the <tt>type</tt> attribute of the
- * <binding> element. This indicates the type of concrete binding
- * extensions contained within this binding.
+ * Set the binding type to the specified URI.
+ * This identifies the type of WSDL extensions used with this binding.
+ * This corresponds to the <code>type</code> attribute of the <binding> element.
*
- * @param type the URI indicating the concrete binding
+ * @param type the URI indicating the binding type
*/
public void setType(URI type);
+
+ /**
+ * Return the URI that identifies the binding type.
+ * This corresponds to the <code>type</code> attribute of the <binding> element.
+ *
+ * @return the binding type URI
+ */
public URI getType();
/*
* Elements
*/
+ /**
+ * Create a BindingFaultElement with this BindingElement as its parent and
+ * return a reference to it.
+ * This equates to adding a <fault> element to the <binding> element.
+ *
+ * @return the BindingFaultElement
+ */
public BindingFaultElement addBindingFaultElement();
+
+ /**
+ * Return the set of BindingFaultElements within this BindingElement.
+ * This equates to the set of <fault> elements within the <binding>.
+ * If no BindingFaultElements exist, an empty array is returned.
+ *
+ * @return an array of BindingFaultElement
+ */
public BindingFaultElement[] getBindingFaultElements();
- //TODO remove method
+ //TODO removeBindingFaultElement method
+
+ /**
+ * Create a BindingOperationElement with this BindingElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <operation> element to the <binding> element.
+ *
+ * @return the BindingOperationElement
+ */
public BindingOperationElement addBindingOperationElement();
+
+ /**
+ * Return the set of BindingOperationElements within this BindingElement
+ * This equates to the set of <operation> elements within the <binding>.
+ * If no BindingOperationElements exist, an empty array is returned.
+ *
+ * @return an array of BindingOperationElement
+ */
public BindingOperationElement[] getBindingOperationElements();
- //TODO remove method
- //TODO extension elements
-
+ //TODO removeBindingOperationElement method
+
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java Mon Feb 5 17:28:38 2007
@@ -19,27 +19,39 @@
import javax.xml.namespace.QName;
/**
- * This interface represents the <fault> child element of a <binding> element.
+ * Represents the WSDL 2.0 <fault> element, declared as a child
+ * of the <binding> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface BindingFaultElement extends DocumentableElement,
NestedElement
{
/**
- * Set the 'ref' attribute to the specified QName, which identifies the
- * interface fault referenced by this binding fault.
+ * Specify the name of the InterfaceFaultElement referred to by this BindingFaultElement.
+ * The specified QName corresponds to the <code>ref</code> attribute of the binding
+ * <fault> element.
*
- * @param qname identifies the associated interface fault.
+ * @param faultName the QName of the interface fault
+ */
+ public void setRef(QName faultName);
+
+ /**
+ * Return the name of the InterfaceFaultElement referred to by this BindingFaultElement.
+ * This corresponds to the <code>ref</code> attribute of the binding <fault> element.
+ *
+ * @return the QName of the interface fault
*/
- public void setRef(QName qname);
public QName getRef();
/**
- * Get the InterfaceFaultElement identified by the QName specified in the
- * <tt>ref</tt> attribute of this binding <fault> element.
+ * Return the InterfaceFaultElement referred to by this BindingFaultElement.
+ * This is resolved from the QName specified in the <code>ref</code> attribute of
+ * the binding <fault> element.
+ * If this QName does not resolve to an InterfaceFaultElement, this method will
+ * return null.
*
- * @return the InterfaceFaultElement associated with this binding fault
+ * @return the InterfaceFaultElement
*/
public InterfaceFaultElement getInterfaceFaultElement();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java Mon Feb 5 17:28:38 2007
@@ -21,33 +21,58 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents the <infault> and <outfault>
- * child elements of a WSDL binding <operation> element.
+ * Represents the WSDL 2.0 <infault> and <outfault> elements,
+ * declared as child elements of the binding <operation> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface BindingFaultReferenceElement extends DocumentableElement,
NestedElement
{
/**
- * Set the 'ref' attribute to the specified QName.
- * @param faultQName the QName identifying the associated InterfaceFaultElement.
+ * Specify the name of the InterfaceFaultReferenceElement referred to by this
+ * BindingFaultReferenceElement.
+ * The specified QName corresponds to the <code>ref</code> attribute of the binding operation
+ * <infault> or <outfault> element.
+ *
+ * @param faultRefName the QName of the interface fault reference.
*/
- public void setRef(QName faultQName);
+ public void setRef(QName faultRefName);
/**
- * Get the QName specified in the 'ref' attribute.
- * @return QName identifies the associated InterfaceFaultElement.
+ * Return the name of the InterfaceFaultReferenceElement referred to by this
+ * BindingFaultReferenceElement.
+ * This corresponds to the <code>ref</code> attribute of the binding operation
+ * <infault> or <outfault> element.
+ *
+ * @return the QName of the interface fault reference
*/
public QName getRef();
/**
- * Get the InterfaceFaultReferenceElement associated with this BindingFaultReferenceElement
- * by the QName specified in the 'ref' attribute.
- * @return InterfaceFaultReferenceElement the associated interface fault reference.
+ * Return the InterfaceFaultReferenceElement referred to by this BindingFaultReferenceElement.
+ * This is resolved from the QName specified in the <code>ref</code> attribute of
+ * the binding operation <infault> or <outfault> element.
+ * If this reference is not resolved to an InterfaceFaultReferenceElement,
+ * this method will return null.
+ *
+ * @return the InterfaceFaultReferenceElement
*/
public InterfaceFaultReferenceElement getInterfaceFaultReferenceElement();
+ /**
+ * Set the message label to the specified NCName. This corresponds to a placeholder message
+ * in the message exchange pattern specified by the parent binding <operation> element.
+ *
+ * @param msgLabel the NCName representing the message label
+ */
public void setMessageLabel(NCName msgLabel);
+
+ /**
+ * Return the NCName representing the message label. This corresponds to a placeholder message
+ * in the message exchange pattern specified by the parent binding <operation> element.
+ *
+ * @return NCName the message label
+ */
public NCName getMessageLabel();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingMessageReferenceElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingMessageReferenceElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingMessageReferenceElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingMessageReferenceElement.java Mon Feb 5 17:28:38 2007
@@ -20,17 +20,52 @@
import org.apache.woden.wsdl20.enumeration.Direction;
/**
- * This interface represents the <input> and <output>
- * child elements of a WSDL binding <operation>.
+ * Represents the WSDL 2.0 <input> and <output> elements,
+ * declared as child elements of the binding <operation> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface BindingMessageReferenceElement extends DocumentableElement,
NestedElement
{
+ /**
+ * Set the message direction using the specified enumerated type, Direction,
+ * which indicates the direction of the message.
+ * Direction.IN corresponds to the binding operation <input> element.
+ * Direction.OUT corresponds to the binding operation <output> element.
+ *
+ * @param dir the Direction of the message
+ */
public void setDirection(Direction dir);
+
+ /**
+ * Returns an enumerated type, Direction, that indicates the direction of this message.
+ * Direction.IN corresponds to the binding operation <input> element.
+ * Direction.OUT corresponds to the binding operation <output> element.
+ *
+ * @return the Direction of the message
+ */
public Direction getDirection();
+ /**
+ * Set the message label to the specified NCName.
+ * This corresponds to the <code>messageLabel</code> attribute of the binding operation
+ * <input> and <output> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent binding <operation> element.
+ *
+ * @param msgLabel the NCName representing the message label
+ */
public void setMessageLabel(NCName msgLabel);
+
+ /**
+ * Return the NCName representing the message label.
+ * This corresponds to the <code>messageLabel</code> attribute of the binding operation
+ * <input> and <output> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent binding <operation> element.
+ *
+ * @return NCName the message label
+ */
public NCName getMessageLabel();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java Mon Feb 5 17:28:38 2007
@@ -19,10 +19,10 @@
import javax.xml.namespace.QName;
/**
- * This interface represents the <operation> child element of a
- * WSDL <binding> element.
+ * Represents the WSDL 2.0 <operation> element, declared as a child
+ * of the <binding> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface BindingOperationElement extends DocumentableElement,
NestedElement
@@ -32,19 +32,30 @@
*/
/**
- * Set the 'ref' attribute to the specified QName, which identifies the
- * interface operation referenced by this binding operation.
+ * Specify the name of the InterfaceOperationElement referred to by this BindingOperationElement.
+ * The specified QName corresponds to the <code>ref</code> attribute of the binding
+ * <operation> element.
*
- * @param qname identifies the associated interface operation.
+ * @param operName the QName of the interface operation.
+ */
+ public void setRef(QName operName);
+
+ /**
+ * Return the name of the InterfaceOperationElement referred to by this BindingOperationElement.
+ * This corresponds to the <code>ref</code> attribute of the binding <operation> element.
+ *
+ * @return the QName of the interface operation
*/
- public void setRef(QName qname);
public QName getRef();
/**
- * Get the InterfaceOperationElement identified by the QName specified in the
- * <tt>ref</tt> attribute of this binding <operation> element.
+ * Return the InterfaceOperationElement referred to by this BindingOperationElement.
+ * This is resolved from the QName specified in the <code>ref</code> attribute of
+ * the binding <operation> element.
+ * If this reference cannot be resolved to an InterfaceOperationElement,
+ * this method will return null.
*
- * @return the InterfaceOperationElement associated with this binding operation
+ * @return the InterfaceOperationElement
*/
public InterfaceOperationElement getInterfaceOperationElement();
@@ -52,12 +63,68 @@
* Elements
*/
+ /**
+ * Create a BindingMessageReferenceElement with this BindingOperationElement as its parent
+ * and return a reference to it.
+ * This equates to adding an <input> or <output> element
+ * to the binding <operation> element.
+ *
+ * @return the BindingMessageReferenceElement
+ */
public BindingMessageReferenceElement addBindingMessageReferenceElement();
+
+ /**
+ * Remove the specified BindingMessageReferenceElement from the set of
+ * BindingMessageReferenceElements within this BindingOperationElement.
+ * This equates to removing an <input> or <output> element
+ * from the binding <operation> element.
+ * If the specified BindingMessageReferenceElement does not exist or if a
+ * null value is specified, no action is performed.
+ *
+ * @param msgRef the BindingMessageReferenceElement to be removed
+ */
public void removeBindingMessageReferenceElement(BindingMessageReferenceElement msgRef);
+
+ /**
+ * Return the set of BindingMessageReferenceElements within this BindingOperationElement.
+ * This equates to the set of <input> and <output> elements
+ * within the binding <operation> element.
+ * If no BindingMessageReferenceElements exist, an empty array is returned.
+ *
+ * @return an array of BindingMessageReferenceElement
+ */
public BindingMessageReferenceElement[] getBindingMessageReferenceElements();
+ /**
+ * Create a BindingFaultReferenceElement with this BindingOperationElement as its parent
+ * and return a reference to it.
+ * This equates to adding an <infault> or <outfault> element
+ * to the binding <operation> element.
+ *
+ * @return the BindingFaultReferenceElement
+ */
public BindingFaultReferenceElement addBindingFaultReferenceElement();
+
+ /**
+ * Remove the specified BindingFaultReferenceElement from the set of
+ * BindingFaultReferenceElements within this BindingOperationElement.
+ * This equates to removing an <infault> or <outfault> element
+ * from the binding <operation> element.
+ * If the specified BindingFaultReferenceElement does not exist or if a
+ * null value is specified, no action is performed.
+ *
+ * @param faultRef the BindingFaultReferenceElement to be removed
+ */
public void removeBindingFaultReferenceElement(BindingFaultReferenceElement faultRef);
+
+ /**
+ * Return the set of BindingFaultReferenceElements within this BindingOperationElement.
+ * This equates to the set of <infault> and <outfault> elements
+ * within the binding <operation> element.
+ * If no BindingFaultReferenceElements exist, an empty array is returned.
+ *
+ * @return an array of BindingFaultReferenceElement
+ */
public BindingFaultReferenceElement[] getBindingFaultReferenceElements();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceElement.java Mon Feb 5 17:28:38 2007
@@ -23,11 +23,9 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents a <interface> XML element
- * information item. It declares the behaviour required to support
- * parsing, creating and manipulating a <interface> element.
+ * Represents the WSDL 2.0 <interface> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface InterfaceElement extends DocumentableElement,
NestedElement
@@ -36,68 +34,171 @@
* Attributes
*/
+ /**
+ * Set the name of this InterfaceElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the <interface> element.
+ *
+ * @param name the NCName that represents the local name of this interface
+ */
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this InterfaceElement, which consists of its
+ * local name and the targetNamespace of the parent DescriptionElement.
+ *
+ * @return the interface QName
+ */
public QName getName();
+ /**
+ * Add the named InterfaceElement to the set of InterfaceElements that this InterfaceElement
+ * extends. This equates to adding a QName to the <code>extends</code> attribute
+ * of the <interface> element.
+ * If a null interface name is specified, no action is performed.
+ *
+ * @param interfaceName the QName of an extended interface
+ */
public void addExtendedInterfaceName(QName interfaceName);
+
+ /**
+ * Remove the named InterfaceElement from the set of InterfaceElements that this
+ * InterfaceElement extends. This equates to removing a QName from the <code>extends</code>
+ * attribute of the <interface> element.
+ * If the named InterfaceElement is not extended by this InterfaceElement or if a null
+ * interface name is specified, no action is performed.
+ *
+ * @param interfaceName the QName of an extended interface
+ */
public void removeExtendedInterfaceName(QName interfaceName);
+
+ /**
+ * Return the qualified names of the InterfaceElements that this InterfaceElement extends.
+ * This equates to the set of QNames defined in the <code>extends</code> attribute
+ * of the <interface> element.
+ * If no extended interfaces exist, an empty array is returned.
+ *
+ * @return an array of QName
+ */
public QName[] getExtendedInterfaceNames();
+ /**
+ * Return the named InterfaceElement from the set of IntefaceElements extended by this
+ * InterfaceElement. The specified QName should equate to a QName defined in the
+ * <code>extends</code> attribute of the <interface> element.
+ * If the named InterfaceElement is not extended by this InterfaceElement or if a null
+ * interface name is specified, this method will return null.
+ *
+ * @param interfaceName the QName of an extended interface
+ * @return the named InterfaceElement
+ */
public InterfaceElement getExtendedInterfaceElement(QName interfaceName);
+
+ /**
+ * Return the set of InterfaceElements extended by this InterfaceElement.
+ * This equates to the set of QNames defined in the <code>extends</code> attribute
+ * of the <interface> element.
+ * If no extended interfaces exist, an empty array is returned.
+ *
+ * @return an array of InterfaceElement
+ */
public InterfaceElement[] getExtendedInterfaceElements();
- public void addStyleDefaultURI(URI uri);
+ /**
+ * Add the specified URI to the set of default operation style URIs.
+ * This equates to adding a URI to the <code>styleDefault</code> attribute
+ * of the <interface> element.
+ * If a null style URI is specified, no action is performed.
+ *
+ * @param style a URI representing an operation style
+ */
+ public void addStyleDefaultURI(URI style);
+
//TODO public void removeStyleDefaultURI(URI uri);
+
+ /**
+ * Return the set of URIs representing the default operation style.
+ * This equates to the URIs defined in the <code>styleDefault</code> attribute
+ * of the <interface> element.
+ * If no style default URIs exist, an empty array is returned.
+ *
+ * @return an array of URI representing the default operation style
+ */
public URI[] getStyleDefault();
+
//TODO add a remove method
/*
* Elements
*/
+ /**
+ * Create an InterfaceFaultElement with this InterfaceElement as its parent and
+ * return a reference to it.
+ * This equates to adding a <fault> element to the <interface> element.
+ *
+ * @return the InterfaceFaultElement
+ */
public InterfaceFaultElement addInterfaceFaultElement();
+
//TODO public void removeInterfaceFaultElement(QName faultName);
/**
- * Returns the InterfaceFaultElement representing the <fault> element
- * with the specified QName from the set of faults declared directly within this
- * <interface> element.
+ * Return the named InterfaceFaultElement from the set of InterfaceFaultElements defined
+ * directly within this InterfaceElement. This equates to a named <fault> element
+ * declared within the <interface> element.
* This set does not include faults derived from extended interfaces.
+ * If the named InterfaceFaultElement does not exist or if a null value is specified,
+ * this method will return null.
*
- * @param faultName the qualified name of the required InterfaceFault
- * @return the InterfaceFault object
+ * @param faultName the QName of the required InterfaceFaultElement
+ * @return the named InterfaceFaultElement
*/
public InterfaceFaultElement getInterfaceFaultElement(QName faultName);
/**
- * Returns the set of InterfaceFaultElements representing the <fault> elements
- * declared directly within this <interface> element.
+ * Return the set of InterfaceFaultElements defined directly within this InterfaceElement.
+ * This equates to the set of <fault> elements declared within this <interface>
+ * element.
* This set does not include faults derived from extended interfaces.
+ * If no InterfaceFaultElements exist, an empty array is returned.
*
- * @return array of InterfaceFaultElement objects
+ * @return array of InterfaceFaultElement
*/
public InterfaceFaultElement[] getInterfaceFaultElements();
+ /**
+ * Create an InterfaceOperationElement with this InterfaceElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <operation> element to the <interface> element.
+ * If no InterfaceOperationElements exist, an empty array is returned.
+ *
+ * @return the InterfaceOperationElement
+ */
public InterfaceOperationElement addInterfaceOperationElement();
+
//TODO public void removeInterfaceOperationElement(QName operName);
/**
- * Returns the InterfaceOperationElement representing the <operation> element
- * with the specified QName from the set of operations declared directly within this
- * <interface> element.
+ * Return the named InterfaceOperationElement from the set of InterfaceOperationElements defined
+ * directly within this InterfaceElement. This equates to a named <operation> element
+ * declared within the <interface> element.
* This set does not include operations derived from extended interfaces.
+ * If the named InterfaceOperationElement does not exist or if a null value is specified,
+ * this method will return null.
*
- * @param operName the qualified name of the required InterfaceOperation
- * @return the InterfaceOperation object
+ * @param operName the QName of the required InterfaceOperationElement
+ * @return the named InterfaceOperationElement
*/
public InterfaceOperationElement getInterfaceOperationElement(QName operName);
/**
- * Returns the set of InterfaceOperationElements representing the <operation> elements
- * declared directly within this <interface> element.
+ * Return the set of InterfaceOperationElements defined directly within this InterfaceElement.
+ * This equates to the set of <operation> elements declared within this <interface>
+ * element.
* This set does not include operations derived from extended interfaces.
+ * If no InterfaceOperationElements exist, an empty array is returned.
*
- * @return array of InterfaceOperationElement objects
+ * @return array of InterfaceOperationElement
*/
public InterfaceOperationElement[] getInterfaceOperationElements();
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java Mon Feb 5 17:28:38 2007
@@ -22,43 +22,61 @@
import org.apache.ws.commons.schema.XmlSchemaElement;
/**
- * This interface represents a <fault> child element of the
- * WSDL <interface> element.
- * It declares the behaviour required to support parsing,
- * creating and manipulating a <fault> element.
+ * Represents the WSDL 2.0 <fault> element, declared as a child of the
+ * <interface> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface InterfaceFaultElement extends DocumentableElement,
NestedElement
{
/**
- * Set the QName that represens the 'name' attribute of the interface
- * <fault> element. This identifies the interface fault.
+ * Set the name of this InterfaceFaultElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the interface <fault> element.
*
- * @param name the NCName that identifies the interface fault
+ * @param name the NCName that represents the local name of this interface fault.
*/
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this InterfaceFaultElement, which consists of its
+ * local name and the targetNamespace of the enclosing DescriptionElement.
+ *
+ * @return the interface fault QName
+ */
public QName getName();
/**
- * Set the QName that represents the 'element' attribute of the interface
- * <fault> element. This identifies a Schema element declaration.
+ * Specify the name of the global schema element declaration referred to by this
+ * InterfaceFaultElement.
+ * The specified QName corresponds to the <code>element</code> attribute of the interface
+ * <fault> element.
+ *
+ * @param elementName the QName of the element declaration
+ */
+ public void setElementName(QName elementName);
+
+ /**
+ * Return the name of the global schema element declaration referred to by this
+ * InterfaceFaultElement.
+ * This corresponds to the <code>element</code> attribute of the interface
+ * <fault> element.
*
- * @param qname the QName that identifies a Schema element declaration
+ * @return the QName of the element declaration
*/
- public void setElementName(QName qname);
public QName getElementName();
/**
- * Returns the Schema element declaration identified by the QName in the 'element'
- * attribute of the interface <fault> element.
- * If this QName does not resolve to an element declaration in a schema that is visible
- * to the containing WSDL description, null will be returned by this method.
- * To be visible, the Schema must have been correctly imported or inlined within
+ * Return the XmlSchemaElement representing the global schema element declaration
+ * referred to by this InterfaceFaultElement.
+ * This is resolved from the QName specified in the <code>element</code> attribute of
+ * the interface <fault> element.
+ * If this QName cannot be not resolved to an element declaration in a schema that
+ * is visible to the enclosing <description> element, this method will return null.
+ * To be visible, the schema must have been correctly imported or inlined within
* the <types> element.
*
- * @return the XmlSchemaElement identified by the 'element' attribute
+ * @return the XmlSchemaElement
*/
public XmlSchemaElement getElement();
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java Mon Feb 5 17:28:38 2007
@@ -22,37 +22,84 @@
import org.apache.woden.wsdl20.enumeration.Direction;
/**
- * This interface represents the <infault> and <outfault>
- * child elements of a WSDL interface <operation> element.
+ * Represents the WSDL 2.0 <infault> and <outfault> elements,
+ * declared as child elements of the interface <operation> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface InterfaceFaultReferenceElement extends DocumentableElement,
NestedElement
{
/**
- * Set the 'ref' attribute to the specified QName.
- * @param faultQName the QName identifying the associated InterfaceFaultElement.
+ * Specify the name of the InterfaceFaultElement referred to by this
+ * InterfaceFaultReferenceElement.
+ * The specified QName corresponds to the <code>ref</code> attribute of the interface operation
+ * <infault> or <outfault> element.
+ *
+ * @param faultName the QName of the interface fault
*/
- public void setRef(QName faultQName);
+ public void setRef(QName faultName);
/**
- * Get the QName specified in the 'ref' attribute.
- * @return QName identifies the associated InterfaceFaultElement.
+ * Return the name of the InterfaceFaultElement referred to by this
+ * InterfaceFaultReferenceElement.
+ * This corresponds to the <code>ref</code> attribute of the interface operation
+ * <infault> or <outfault> element.
+ *
+ * @return the QName of the interface fault
*/
public QName getRef();
/**
- * Get the InterfaceFaultElement associated with this InterfaceFaultReferenceElement
- * by the QName specified in the 'ref' attribute.
- * @return InterfaceFaultElement the associated interface fault.
+ * Return the InterfaceFaultElement referred to by this InterfaceFaultReferenceElement.
+ * This is resolved from the QName specified in the <code>ref</code> attribute of
+ * the interface operation <infault> or <outfault> element.
+ * If this reference is not resolved to an InterfaceFaultElement,
+ * this method will return null.
+ *
+ * @return the InterfaceFaultElement
*/
public InterfaceFaultElement getInterfaceFaultElement();
+ /**
+ * Set the message label to the specified NCName.
+ * This corresponds to the <code>messageLabel</code> attribute of the interface operation
+ * <infault> and <outfault> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent interface <operation> element.
+ *
+ * @param msgLabel the NCName representing the message label
+ */
public void setMessageLabel(NCName msgLabel);
+
+ /**
+ * Return the NCName representing the message label.
+ * This corresponds to the <code>messageLabel</code> attribute of the interface operation
+ * <infault> and <outfault> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent interface <operation> element.
+ *
+ * @return NCName the message label
+ */
public NCName getMessageLabel();
+ /**
+ * Set the message direction using the specified enumerated type, Direction,
+ * which indicates the direction of the fault.
+ * Direction.IN corresponds to the interface operation <infault> element.
+ * Direction.OUT corresponds to the interface operation <outfault> element.
+ *
+ * @param dir the Direction of the fault
+ */
public void setDirection(Direction dir);
+
+ /**
+ * Returns an enumerated type, Direction, that indicates the direction of this fault.
+ * Direction.IN corresponds to the interface operation <infault> element.
+ * Direction.OUT corresponds to the interface operation <outfault> element.
+ *
+ * @return the Direction of the fault
+ */
public Direction getDirection();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java Mon Feb 5 17:28:38 2007
@@ -23,43 +23,102 @@
import org.apache.ws.commons.schema.XmlSchemaElement;
/**
- * This interface represents the <input> and <output>
- * child elements of interface operation.
+ * Represents the WSDL 2.0 <input> and <output> elements,
+ * declared as child elements of interface <operation> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface InterfaceMessageReferenceElement extends DocumentableElement,
NestedElement
{
+ /**
+ * Set the message label to the specified NCName.
+ * This corresponds to the <code>messageLabel</code> attribute of the interface operation
+ * <input> and <output> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent interface <operation> element.
+ *
+ * @param msgLabel the NCName representing the message label
+ */
public void setMessageLabel(NCName msgLabel);
+
+ /**
+ * Return the NCName representing the message label.
+ * This corresponds to the <code>messageLabel</code> attribute of the interface operation
+ * <input> and <output> elements.
+ * It represents a placeholder message in the message exchange pattern specified by the
+ * parent interface <operation> element.
+ *
+ * @return NCName the message label
+ */
public NCName getMessageLabel();
+ /**
+ * This is a property of the component model, not the infoset.
+ * <p>
+ * TODO Post-M7, deprecate/remove this method from this interface.
+ */
public void setMessageContentModel(String nmToken);
+
+
+ /**
+ * This is a property of the component model, not the infoset.
+ * <p>
+ * TODO Post-M7, deprecate/remove this method from this interface.
+ */
public String getMessageContentModel();
/**
- * Set the QName that represents the 'element' attribute of the interface
- * operation <input> or <output> element. This identifies a Schema
- * element declaration.
+ * Specify the name of the global schema element declaration referred to by this
+ * InterfaceMessageReferenceElement.
+ * The specified QName corresponds to the <code>element</code> attribute of the interface
+ * operation <input> or <output> element.
+ *
+ * @param elementName the QName of the element declaration
+ */
+ public void setElementName(QName elementName);
+
+ /**
+ * Return the name of the global schema element declaration referred to by this
+ * InterfaceMessageReferenceElement.
+ * This corresponds to the <code>element</code> attribute of the interface
+ * operation <input> or <output> element.
*
- * @param element the QName that identifies a Schema element declaration
+ * @return the QName of the element declaration
*/
- public void setElementName(QName element);
public QName getElementName();
/**
- * Returns the Schema element declaration identified by the QName in the 'element'
- * attribute of the interface operation <input> or <output> element.
- * If this QName does not resolve to an element declaration in a schema that is visible
- * to the containing WSDL description, null will be returned by this method.
- * To be visible, the Schema must have been correctly imported or inlined within
+ * Return the XmlSchemaElement representing the global schema element declaration
+ * referred to by this InterfaceMessageReferenceElement.
+ * This is resolved from the QName specified in the <code>element</code> attribute of
+ * the interface operation <input> or <output> element.
+ * If this QName cannot be not resolved to an element declaration in a schema that
+ * is visible to the enclosing <description> element, this method will return null.
+ * To be visible, the schema must have been correctly imported or inlined within
* the <types> element.
*
- * @return the XmlSchemaElement identified by the 'element' attribute
+ * @return the XmlSchemaElement
*/
public XmlSchemaElement getElement();
+ /**
+ * Set the message direction using the specified enumerated type, Direction,
+ * which indicates the direction of the message.
+ * Direction.IN corresponds to the interface operation <input> element.
+ * Direction.OUT corresponds to the interface operation <output> element.
+ *
+ * @param dir the Direction of the message
+ */
public void setDirection(Direction dir);
+
+ /**
+ * Returns an enumerated type, Direction, that indicates the direction of this message.
+ * Direction.IN corresponds to the interface operation <input> element.
+ * Direction.OUT corresponds to the interface operation <output> element.
+ *
+ * @return the Direction of the message
+ */
public Direction getDirection();
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceOperationElement.java
URL: http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceOperationElement.java?view=diff&rev=503949&r1=503948&r2=503949
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceOperationElement.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceOperationElement.java Mon Feb 5 17:28:38 2007
@@ -23,12 +23,10 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents an <operation> child element
- * of the WSDL <interface> element.
- * It declares the behaviour required to support parsing,
- * creating and manipulating an <operation> element.
+ * Represents the WSDL 2.0 <operation> element, declared as a child
+ * of the <interface> element.
*
- * @author jkaputin@apache.org
+ * @author John Kaputin (jkaputin@apache.org)
*/
public interface InterfaceOperationElement extends DocumentableElement,
NestedElement
@@ -37,26 +35,138 @@
* Attributes
*/
+ /**
+ * Set the name of this InterfaceOperationElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the interface <operation> element.
+ *
+ * @param name the NCName that represents the local name of this interface operation
+ */
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this InterfaceOperationElement, which consists of its
+ * local name and the targetNamespace of the enclosing DescriptionElement.
+ *
+ * @return the interface operation QName
+ */
public QName getName();
- public void setPattern(URI uri);
+ /**
+ * Set the message exchange pattern used by this InterfaceOperationElement to the specified
+ * URI.
+ * This corresponds to the <code>pattern</code> attribute of the interface <operation>
+ * element.
+ *
+ * @param mep the message exchange pattern URI
+ */
+ public void setPattern(URI mep);
+
+ /**
+ * Return the URI representing the message exchange pattern used by this InterfaceOperationElement.
+ * This corresponds to the <code>name</code> attribute of the interface <operation> element.
+ *
+ * @return the URI representing the message exchange pattern
+ */
public URI getPattern();
- public void addStyleURI(URI uri);
- public void removeStyleURI(URI uri);
+ /**
+ * Add the specified URI to the set of style URIs used by this InterfaceOperationElement.
+ * This equates to adding a URI to the <code>style</code> attribute of the interface
+ * <operation> element.
+ * If a null style URI is specified, no action is performed.
+ *
+ * @param style a URI representing an operation style
+ */
+ public void addStyleURI(URI style);
+
+
+ /**
+ * Remove the specified URI from the set of style URIs used by this InterfaceOperationElement.
+ * This equates to removing a URI from the <code>style</code> attribute of the interface
+ * <operation> element.
+ * If the specified URI is not present in the set of style URIs or if a null URI is specified,
+ * no action is performed.
+ *
+ * @param style a URI representing an operation style
+ */
+ public void removeStyleURI(URI style);
+
+ /**
+ * Return the set of URIs representing the operation style.
+ * This corresponds to the URIs defined in the <code>style</code> attribute of the interface
+ * <operation> element.
+ * If no style URIs exist, an empty array is returned.
+ *
+ * @return an array of URI representing the operation style
+ */
public URI[] getStyle();
/*
* Elements
*/
+ /**
+ * Create an InterfaceMessageReferenceElement with this InterfaceOperationElement as its parent
+ * and return a reference to it.
+ * This equates to adding an <input> or <output> element to the interface
+ * <operation> element.
+ *
+ * @return the InterfaceMessageReferenceElement
+ */
public InterfaceMessageReferenceElement addInterfaceMessageReferenceElement();
+
+ /**
+ * Remove the specified InterfaceMessageReferenceElement from the set of
+ * InterfaceMessageReferenceElements within this InterfaceOperationElement.
+ * This equates to removing an <input> or <output> element
+ * from the interface <operation> element.
+ * If the specified InterfaceMessageReferenceElement does not exist or if a
+ * null value is specified, no action is performed.
+ *
+ * @param msgRef the InterfaceMessageReferenceElement to be removed
+ */
public void removeInterfaceMessageReferenceElement(InterfaceMessageReferenceElement msgRef);
+
+ /**
+ * Return the set of InterfaceMessageReferenceElements within this InterfaceOperationElement.
+ * This equates to the set of <input> and <output> elements
+ * within the interface <operation> element.
+ * If no InterfaceMessageReferenceElements exist, an empty array is returned.
+ *
+ * @return an array of InterfaceMessageReferenceElement
+ */
public InterfaceMessageReferenceElement[] getInterfaceMessageReferenceElements();
+ /**
+ * Create an InterfaceFaultReferenceElement with this InterfaceOperationElement as its parent
+ * and return a reference to it.
+ * This equates to adding an <infault> or <outfault> element to the interface
+ * <operation> element.
+ *
+ * @return the InterfaceFaultReferenceElement
+ */
public InterfaceFaultReferenceElement addInterfaceFaultReferenceElement();
+
+ /**
+ * Remove the specified InterfaceFaultReferenceElement from the set of
+ * InterfaceFaultReferenceElements within this InterfaceOperationElement.
+ * This equates to removing an <infault> or <outfault> element
+ * from the interface <operation> element.
+ * If the specified InterfaceFaultReferenceElement does not exist or if a
+ * null value is specified, no action is performed.
+ *
+ * @param faultRef the InterfaceFaultReferenceElement to be removed
+ */
public void removeInterfaceFaultReferenceElement(InterfaceFaultReferenceElement faultRef);
+
+ /**
+ * Return the set of InterfaceFaultReferenceElement within this InterfaceOperationElement.
+ * This equates to the set of <infault> and <outfault> elements
+ * within the interface <operation> element.
+ * If no InterfaceFaultReferenceElements exist, an empty array is returned.
+ *
+ * @return an array of InterfaceFaultReferenceElement
+ */
public InterfaceFaultReferenceElement[] getInterfaceFaultReferenceElements();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: woden-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: woden-dev-help@ws.apache.org