Release 10.1A: OpenEdge Development:
Web Services

> ## SOAP header-entryref object attributes and methods

> Table 11–4 briefly describes all of the attributes on the SOAP header-entryref object that are unique to the object or have special application to the SOAP header-entryref object.

> Table 11–4: SOAP header-entryref object attributes
> Attribute | Type | Description
> --- | --- | ---
>     ACTOR
>     CHARACTER
> | Returns the value of the `actor` attribute specified in the associated SOAP header entry.
>     LOCAL-NAME
>     CHARACTER
> | Returns the unqualified part of name specified for the associated SOAP header entry element.
>     MUST-UNDERSTAND
>     LOGICAL
> | Returns the value of the `mustUnderstand` attribute specified in the associated SOAP header entry.
>     NAME
>     CHARACTER
> | Returns the qualified name of the SOAP header entry (`"``namespacePrefix``:``localName`").
>     NAMESPACE-URI
>     CHARACTER
> | Returns the namespace URI prefixed to the associated SOAP header entry element’s name.
>     TYPE
>     CHARACTER
> | Returns the handle type, `"SOAP-HEADER-ENTRYREF"`.

> Table 11–5 briefly describes all of the methods on the SOAP header-entryref object.

> Note: All of the methods and functions listed in Table 11–5 return `TRUE` only if there is an underlying SOAP header entry (XML sub-tree) associated with the object handle.

> Table 11–5: SOAP header-entryref object methods
> Method | Type | Description
> --- | --- | ---
>     DELETE-HEADER-ENTRY
>     ( )
>     LOGICAL
> | Deletes the underlying SOAP header entry and all of its content, but does not delete the SOAP header-entryref object used to reference the deleted header entry.
>     GET-NODE (handle)
>     LOGICAL
> | Returns a handle (`handle`) to an X-noderef object that references the root node of a DOM tree containing the parsed XML for the underlying SOAP header entry.
>     GET-SERIALIZED ( )
>     LONGCHAR
> | Returns the XML for the underlying SOAP header entry in serialized form.
>     SET-ACTOR (string)
>     LOGICAL
> | Sets the value (`string`) of the `actor` attribute in the underlying SOAP header entry. This method returns `TRUE` only if there is an underlying SOAP header entry (XML sub-tree) associated with the object handle.
>     SET-MUST-UNDERSTAND
>     (logical)
>     LOGICAL
> | Sets the value (`logical`) of the `mustUnderstand` attribute in the underlying SOAP header entry. This method returns `TRUE` only if there is an underlying SOAP header entry (XML sub-tree) associated with the object handle.
>     SET-NODE (hXnoderef)
>     LOGICAL
> | Replaces the header entry referenced by this SOAP header-entryref object with a specified DOM sub-tree (parsed XML) that is assumed to represent a SOAP header entry element. The method performs a deep copy of the XML sub-tree specified by the X-noderef object handle (`hXnoderef`).
>     SET-SERIALIZED
>     (longchar)
>     LOGICAL
> | Replaces the header entry referenced by this SOAP header-entryref object with serialized XML (`longchar`) that is then parsed into a DOM sub-tree that represents a SOAP header entry element. The XML is assumed to be valid for a SOAP header entry.

> For more information on these attributes and methods, see OpenEdge Development: Progress 4GL Reference .

Copyright © 2005 Progress Software Corporation www.progress.com Voice: (781) 280-4000 Fax: (781) 280-4095