org.apache.woden.wsdl20.xml
Interface InterfaceOperationElement

All Superinterfaces:
AttributeExtensible, DocumentableElement, ElementExtensible, NestedElement, WSDLElement
All Known Implementing Classes:
InterfaceOperationImpl

public interface InterfaceOperationElement
extends DocumentableElement, NestedElement

Represents the WSDL 2.0 <operation> element, declared as a child of the <interface> element.

Author:
John Kaputin (jkaputin@apache.org)

Method Summary
 InterfaceFaultReferenceElement addInterfaceFaultReferenceElement()
          Create an InterfaceFaultReferenceElement with this InterfaceOperationElement as its parent and return a reference to it.
 InterfaceMessageReferenceElement addInterfaceMessageReferenceElement()
          Create an InterfaceMessageReferenceElement with this InterfaceOperationElement as its parent and return a reference to it.
 void addStyleURI(java.net.URI style)
          Add the specified URI to the set of style URIs used by this InterfaceOperationElement.
 InterfaceFaultReferenceElement[] getInterfaceFaultReferenceElements()
          Return the set of InterfaceFaultReferenceElement within this InterfaceOperationElement.
 InterfaceMessageReferenceElement[] getInterfaceMessageReferenceElements()
          Return the set of InterfaceMessageReferenceElements within this InterfaceOperationElement.
 QName getName()
          Return the qualified name of this InterfaceOperationElement, which consists of its local name and the targetNamespace of the enclosing DescriptionElement.
 java.net.URI getPattern()
          Return the URI representing the message exchange pattern used by this InterfaceOperationElement.
 java.net.URI[] getStyle()
          Return the set of URIs representing the operation style.
 void removeInterfaceFaultReferenceElement(InterfaceFaultReferenceElement faultRef)
          Remove the specified InterfaceFaultReferenceElement from the set of InterfaceFaultReferenceElements within this InterfaceOperationElement.
 void removeInterfaceMessageReferenceElement(InterfaceMessageReferenceElement msgRef)
          Remove the specified InterfaceMessageReferenceElement from the set of InterfaceMessageReferenceElements within this InterfaceOperationElement.
 void removeStyleURI(java.net.URI style)
          Remove the specified URI from the set of style URIs used by this InterfaceOperationElement.
 void setName(NCName name)
          Set the name of this InterfaceOperationElement to the specified NCName.
 void setPattern(java.net.URI mep)
          Set the message exchange pattern used by this InterfaceOperationElement to the specified URI.
 
Methods inherited from interface org.apache.woden.wsdl20.xml.DocumentableElement
addDocumentationElement, getDocumentationElements
 
Methods inherited from interface org.apache.woden.wsdl20.xml.NestedElement
getParentElement, setParentElement
 
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

setName

void setName(NCName name)
Set the name of this InterfaceOperationElement to the specified NCName. This corresponds to the name attribute of the interface <operation> element.

Parameters:
name - the NCName that represents the local name of this interface operation

getName

QName getName()
Return the qualified name of this InterfaceOperationElement, which consists of its local name and the targetNamespace of the enclosing DescriptionElement.

Returns:
the interface operation QName

setPattern

void setPattern(java.net.URI mep)
Set the message exchange pattern used by this InterfaceOperationElement to the specified URI. This corresponds to the pattern attribute of the interface <operation> element.

Parameters:
mep - the message exchange pattern URI

getPattern

java.net.URI getPattern()
Return the URI representing the message exchange pattern used by this InterfaceOperationElement. This corresponds to the name attribute of the interface <operation> element.

Returns:
the URI representing the message exchange pattern

addStyleURI

void addStyleURI(java.net.URI style)
Add the specified URI to the set of style URIs used by this InterfaceOperationElement. This equates to adding a URI to the style attribute of the interface <operation> element. If a null style URI is specified, no action is performed.

Parameters:
style - a URI representing an operation style

removeStyleURI

void removeStyleURI(java.net.URI style)
Remove the specified URI from the set of style URIs used by this InterfaceOperationElement. This equates to removing a URI from the style 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.

Parameters:
style - a URI representing an operation style

getStyle

java.net.URI[] getStyle()
Return the set of URIs representing the operation style. This corresponds to the URIs defined in the style attribute of the interface <operation> element. If no style URIs exist, an empty array is returned.

Returns:
an array of URI representing the operation style

addInterfaceMessageReferenceElement

InterfaceMessageReferenceElement addInterfaceMessageReferenceElement()
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.

Returns:
the InterfaceMessageReferenceElement

removeInterfaceMessageReferenceElement

void removeInterfaceMessageReferenceElement(InterfaceMessageReferenceElement msgRef)
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.

Parameters:
msgRef - the InterfaceMessageReferenceElement to be removed

getInterfaceMessageReferenceElements

InterfaceMessageReferenceElement[] getInterfaceMessageReferenceElements()
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.

Returns:
an array of InterfaceMessageReferenceElement

addInterfaceFaultReferenceElement

InterfaceFaultReferenceElement addInterfaceFaultReferenceElement()
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.

Returns:
the InterfaceFaultReferenceElement

removeInterfaceFaultReferenceElement

void removeInterfaceFaultReferenceElement(InterfaceFaultReferenceElement faultRef)
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.

Parameters:
faultRef - the InterfaceFaultReferenceElement to be removed

getInterfaceFaultReferenceElements

InterfaceFaultReferenceElement[] getInterfaceFaultReferenceElements()
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.

Returns:
an array of InterfaceFaultReferenceElement


Copyright © 2007. All Rights Reserved.