org.apache.woden.internal.wsdl20
Class InterfaceMessageReferenceImpl

java.lang.Object
  extended by org.apache.woden.internal.wsdl20.WSDLElementImpl
      extended by org.apache.woden.internal.wsdl20.WSDLObjectImpl
          extended by org.apache.woden.internal.wsdl20.DocumentableImpl
              extended by org.apache.woden.internal.wsdl20.NestedImpl
                  extended by org.apache.woden.internal.wsdl20.InterfaceMessageReferenceImpl
All Implemented Interfaces:
AttributeExtensible, ElementExtensible, InterfaceMessageReference, NestedComponent, WSDLComponent, DocumentableElement, InterfaceMessageReferenceElement, NestedElement, WSDLElement

public class InterfaceMessageReferenceImpl
extends NestedImpl
implements InterfaceMessageReference, InterfaceMessageReferenceElement

This class represents the <input> and <output> child elements of interface operation.

Author:
jkaputin@apache.org

Constructor Summary
InterfaceMessageReferenceImpl()
           
 
Method Summary
 Direction getDirection()
          Returns an enumerated type, Direction, that indicates the direction of this message.
 org.apache.ws.commons.schema.XmlSchemaElement getElement()
          Return the XmlSchemaElement representing the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 ElementDeclaration getElementDeclaration()
          Returns the ElementDeclaration representing the {element declaration} property of this InterfaceMessageReference.
 QName getElementName()
          Return the name of the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 java.lang.String getMessageContentModel()
          Returns a String representing the {message content model} property of this InterfaceMessageReference.
 NCName getMessageLabel()
          Returns an NCName representing the {message label} property of this InterfaceMessageReference.
 void setDirection(Direction dir)
          Set the message direction using the specified enumerated type, Direction, which indicates the direction of the message.
 void setElementName(QName element)
          Specify the name of the global schema element declaration referred to by this InterfaceMessageReferenceElement.
 void setMessageContentModel(java.lang.String nmToken)
           
 void setMessageLabel(NCName msgLabel)
          Set the message label to the specified NCName.
 InterfaceMessageReferenceElement toElement()
          Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.
 
Methods inherited from class org.apache.woden.internal.wsdl20.NestedImpl
getParent, getParentElement, setParentElement
 
Methods inherited from class org.apache.woden.internal.wsdl20.DocumentableImpl
addDocumentationElement, getDocumentationElements
 
Methods inherited from class org.apache.woden.internal.wsdl20.WSDLObjectImpl
containsComponent, equals, getComponentExtensionsForNamespace, setComponentExtensions
 
Methods inherited from class org.apache.woden.internal.wsdl20.WSDLElementImpl
addExtensionElement, getExtensionAttribute, getExtensionAttributes, getExtensionAttributesForNamespace, getExtensionElements, getExtensionElementsOfType, hasExtensionAttributesForNamespace, hasExtensionElementsForNamespace, removeExtensionElement, setExtensionAttribute
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.woden.wsdl20.NestedComponent
getParent
 
Methods inherited from interface org.apache.woden.wsdl20.WSDLComponent
equals, getComponentExtensionsForNamespace
 
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
 

Constructor Detail

InterfaceMessageReferenceImpl

public InterfaceMessageReferenceImpl()
Method Detail

getMessageLabel

public NCName getMessageLabel()
Description copied from interface: InterfaceMessageReference
Returns an NCName representing the {message label} property of this InterfaceMessageReference. This associates the message with a placeholder message in the message exchange pattern specified by the parent interface operation.

Specified by:
getMessageLabel in interface InterfaceMessageReference
Specified by:
getMessageLabel in interface InterfaceMessageReferenceElement
Returns:
an NCName representing the message label

getDirection

public Direction getDirection()
Description copied from interface: InterfaceMessageReference
Returns an enumerated type, Direction, that indicates the direction of this message. Direction.IN corresponds to an input message. Direction.OUT corresponds to an output message.

Specified by:
getDirection in interface InterfaceMessageReference
Specified by:
getDirection in interface InterfaceMessageReferenceElement
Returns:
the Direction of this message

getMessageContentModel

public java.lang.String getMessageContentModel()
Description copied from interface: InterfaceMessageReference
Returns a String representing the {message content model} property of this InterfaceMessageReference. This specifies a token indicating the type of message content. '#any' means any single element, '#none' means no message content, '#other' means non-XML extension type system and '#element' means XML Schema global element definition.

Specified by:
getMessageContentModel in interface InterfaceMessageReference
Specified by:
getMessageContentModel in interface InterfaceMessageReferenceElement
Returns:
String representing the type of message content

getElementDeclaration

public ElementDeclaration getElementDeclaration()
Description copied from interface: InterfaceMessageReference
Returns the ElementDeclaration representing the {element declaration} property of this InterfaceMessageReference. This describes the content or "payload" of the message.

Specified by:
getElementDeclaration in interface InterfaceMessageReference
Returns:
the ElementDeclaration that describes the message content.

toElement

public InterfaceMessageReferenceElement toElement()
Description copied from interface: InterfaceMessageReference
Returns a WSDLElement that represents the element information item from the WSDL 2.0 infoset that maps to this WSDLComponent.

Specified by:
toElement in interface InterfaceMessageReference
Returns:
the InterfaceMessageReferenceElement that maps to this InterfaceMessageReference

setMessageLabel

public void setMessageLabel(NCName msgLabel)
Description copied from interface: InterfaceMessageReferenceElement
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.

Specified by:
setMessageLabel in interface InterfaceMessageReferenceElement
Parameters:
msgLabel - the NCName representing the message label

setMessageContentModel

public void setMessageContentModel(java.lang.String nmToken)
Specified by:
setMessageContentModel in interface InterfaceMessageReferenceElement

setElementName

public void setElementName(QName element)
Description copied from interface: InterfaceMessageReferenceElement
Specify the name of the global schema element declaration referred to by this InterfaceMessageReferenceElement. The specified QName corresponds to the element attribute of the interface operation <input> or <output> element.

Specified by:
setElementName in interface InterfaceMessageReferenceElement
Parameters:
element - the QName of the element declaration

getElementName

public QName getElementName()
Description copied from interface: InterfaceMessageReferenceElement
Return the name 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.

Specified by:
getElementName in interface InterfaceMessageReferenceElement
Returns:
the QName of the element declaration

getElement

public org.apache.ws.commons.schema.XmlSchemaElement getElement()
Description copied from interface: InterfaceMessageReferenceElement
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.

Specified by:
getElement in interface InterfaceMessageReferenceElement
Returns:
the XmlSchemaElement

setDirection

public void setDirection(Direction dir)
Description copied from interface: InterfaceMessageReferenceElement
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.

Specified by:
setDirection in interface InterfaceMessageReferenceElement
Parameters:
dir - the Direction of the message


Copyright © 2007. All Rights Reserved.