org.apache.woden.wsdl20.xml
Interface DocumentableElement

All Superinterfaces:

AttributeExtensible, ElementExtensible, WSDLElement

All Known Subinterfaces:

BindingElement, BindingFaultElement, BindingFaultReferenceElement, BindingMessageReferenceElement, BindingOperationElement, DescriptionElement, EndpointElement, ImportElement, IncludeElement, InterfaceElement, InterfaceFaultElement, InterfaceFaultReferenceElement, InterfaceMessageReferenceElement, InterfaceOperationElement, ServiceElement, TypesElement

All Known Implementing Classes:

BindingFaultImpl, BindingFaultReferenceImpl, BindingImpl, BindingMessageReferenceImpl, BindingOperationImpl, DescriptionImpl, DocumentableImpl, EndpointImpl, ImportImpl, IncludeImpl, InterfaceFaultImpl, InterfaceFaultReferenceImpl, InterfaceImpl, InterfaceMessageReferenceImpl, InterfaceOperationImpl, ServiceImpl, TypesImpl

public interface DocumentableElement

extends WSDLElement

Represents WSDL 2.0 elements that can have <documentation> child elements. That is, all WSDL 2.0 elements except the <documentation> element itself. The Java interfaces that correspond to these WSDL elements will extend this interface to inherit the behaviour for getting, adding and removing DocumentationElements.

TODO a removeDocmentationElement method

Author:

John Kaputin (jkaputin@apache.org)

Method Summary

DocumentationElement	addDocumentationElement() Create a DocumentationElement with this WSDLElement as its parent and return a reference to it.
DocumentationElement[]	getDocumentationElements() Return the set of DocumentationElements defined directly within this WSDLElement.

Methods inherited from interface org.apache.woden.wsdl20.extensions.AttributeExtensible

getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, hasExtensionAttributesForNamespace, setExtensionAttribute

Methods inherited from interface org.apache.woden.wsdl20.extensions.ElementExtensible

addExtensionElement, getExtensionElements, getExtensionElementsOfType, hasExtensionElementsForNamespace, removeExtensionElement

Method Detail

addDocumentationElement

public DocumentationElement addDocumentationElement()

Create a DocumentationElement with this WSDLElement as its parent and return a reference to it. This equates to adding a <documentation> element to any of the other WSDL elements (except the <documentation> element itself).

Returns:

the DocumentationElement

getDocumentationElements

public DocumentationElement[] getDocumentationElements()

Return the set of DocumentationElements defined directly within this WSDLElement. This equates to the set of <documentation> elements declared within a WSDL element. If no DocumentationElements exist, an empty array is returned.

Returns:

array of DocumentationElement