org.apache.woden.wsdl20.xml
Interface InterfaceMessageReferenceElement

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

public interface InterfaceMessageReferenceElement
extends DocumentableElement, NestedElement

Represents the WSDL 2.0 <input> and <output> elements, declared as child elements of interface <operation> element.

Author:
John Kaputin (jkaputin@apache.org)

Method Summary
 Direction getDirection()
          Returns an enumerated type, Direction, that indicates the direction of this message.
 QNameTokenUnion getElement()
          Return the union of the xs:token and xs:QName of the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 NCName getMessageLabel()
          Return the NCName representing the message label.
 org.apache.ws.commons.schema.XmlSchemaElement getXmlSchemaElement()
          Return the XmlSchemaElement representing the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 void setDirection(Direction dir)
          Set the message direction using the specified enumerated type, Direction, which indicates the direction of the message.
 void setElement(QNameTokenUnion element)
          Specify the union of the xs:token and xs:QName of the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 void setMessageLabel(NCName msgLabel)
          Set the message label to the specified NCName.
 
Methods inherited from interface org.apache.woden.wsdl20.xml.DocumentableElement
addDocumentationElement, getDocumentationElements
 
Methods inherited from interface org.apache.woden.wsdl20.xml.NestedElement
getParentElement
 
Methods inherited from interface org.apache.woden.wsdl20.xml.WSDLElement
addNamespace, getDeclaredNamespaces, getInScopeNamespaces, getNamespacePrefix, getNamespaceURI, removeNamespace
 
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

setMessageLabel

void setMessageLabel(NCName msgLabel)
Set the message label to the specified NCName. This corresponds to the messageLabel 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.

Parameters:
msgLabel - the NCName representing the message label

getMessageLabel

NCName getMessageLabel()
Return the NCName representing the message label. This corresponds to the messageLabel 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.

Returns:
NCName the message label

setElement

void setElement(QNameTokenUnion element)
Specify the union of the xs:token and xs:QName of the global schema element declaration referred to by this InterfaceMessageReferenceElement. The specified QNameTokenEnum corresponds to the element attribute of the interface operation <input> or <output> element.

Parameters:
element - the QNameTokenEnum of the element declaration.

getElement

QNameTokenUnion getElement()
Return the union of the xs:token and xs:QName of the global schema element declaration referred to by this InterfaceMessageReferenceElement. This corresponds to the element attribute of the interface operation <input> or <output> element.

Returns:
the QNameTokenEnum of the element declaration

getXmlSchemaElement

org.apache.ws.commons.schema.XmlSchemaElement getXmlSchemaElement()
Return the XmlSchemaElement representing the global schema element declaration referred to by this InterfaceMessageReferenceElement. This equates to the <xs:element> element referred to by the element attribute of the interface operation <input> or <output> element. If this reference cannot be resolved to an element declaration in a schema that is visible to the enclosing <description>, this method will return null. To be visible, the schema must have been correctly imported or inlined within the <types> element.

Returns:
the XmlSchemaElement

setDirection

void setDirection(Direction dir)
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.

Parameters:
dir - the Direction of the message

getDirection

Direction getDirection()
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.

Returns:
the Direction of the message


Copyright © 2005-2010 Apache Software Foundation. All Rights Reserved.