org.apache.woden.wsdl20.extensions.soap

## Interface SOAPHeaderBlockElement

- All Superinterfaces:
    AttributeExtensible, ElementExtensible, ExtensionElement

      public interface SOAPHeaderBlockElement
      extends ExtensionElement, AttributeExtensible, ElementExtensible

  This interface represents the <wsoap:header> extension element that can appear within a Binding Fault or Binding Message Reference.
  Author:
    jkaputin@apache.org

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addDocumentationElement(DocumentationElement docEl)`
    `DocumentationElement[]` | `getDocumentationElements()`
    `org.apache.ws.commons.schema.XmlSchemaElement` | `getElement()` Returns the Schema element declaration identified by the QName in the 'element' attribute of the <wsoap:header> element.
    `QName` | `getElementName()`
    `WSDLElement` | `getParentElement()`
    `Boolean` | `mustUnderstand()`
    `void` | `setElementName(QName qname)` Set the QName that identifies the Schema element declaration relating to this soap header.
    `void` | `setMustUnderstand(Boolean understood)`
    `void` | `setParentElement(WSDLElement wsdlEl)`

    - ### Methods inherited from interface org.apache.woden.wsdl20.extensions.ExtensionElement

      `getExtensionType, isRequired, setExtensionType, setRequired`

    - ### 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

    - #### setElementName

          void setElementName(QName qname)

      Set the QName that identifies the Schema element declaration relating to this soap header.
      Parameters:
        `qname` - the QName that identifies a Schema element declaration

    - #### getElementName

          QName getElementName()

    - #### getElement

          org.apache.ws.commons.schema.XmlSchemaElement getElement()

      Returns the Schema element declaration identified by the QName in the 'element' attribute of the <wsoap:header> 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 the <types> element.
      Returns:
        the XmlSchemaElement identified by the 'element' attribute

    - #### setMustUnderstand

          void setMustUnderstand(Boolean understood)

    - #### mustUnderstand

          Boolean mustUnderstand()

    - #### setParentElement

          void setParentElement(WSDLElement wsdlEl)

    - #### getParentElement

          WSDLElement getParentElement()

    - #### addDocumentationElement

          void addDocumentationElement(DocumentationElement docEl)

    - #### getDocumentationElements

          DocumentationElement[] getDocumentationElements()

Copyright ? Apache Software Foundation. All Rights Reserved.