com.goldencode.p2j.util

Interface SOAPHeaderEntry

All Superinterfaces:

ADMData, LocalName, NamespaceURI, UniqueID

All Known Subinterfaces:

HandleCommon

All Known Implementing Classes:

SOAPHeaderEntryImpl

public interface SOAPHeaderEntry
extends LocalName, ADMData, UniqueID, NamespaceURI

Interface describing the features for SOAP-HEADER-ENTRY resource:

• ACTOR attribute
• MUST-UNDERSTAND attribute
• DELETE-HEADER-ENTRY method
• SET-ACTOR method
• SET-MUST-UNDERSTAND method
• SET-NODE method
• SET-SERIALIZED method

Method Summary

Modifier and Type	Method and Description
logical	deleteHeaderEntry() Deletes the XML underlying a SOAP-HEADER-ENTRYREF object, without deleting the object.
character	getActor() Returns the value of the actor attribute for the SOAP-HEADER-ENTRYREF object as a URL.
logical	isMustUnderstand() Indicates whether a SOAP-HEADER-ENTRYREF object is mandatory (TRUE) or optional (FALSE) for the recipient to process.
logical	setActor(character uri) Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.
logical	setActor(java.lang.String uri) Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.
logical	setMustUnderstand(boolean val) Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.
logical	setMustUnderstand(logical val) Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.
logical	setNode(handle xNoderef) Replaces the underlying XML of a SOAP-HEADER-ENTRYREF object with the DOM XML sub-tree rooted by the X-NODEREF object.
logical	setSerialized(longchar xml) Sets the SOAP-header-entryref object's underlying XML from serialized XML.

Methods inherited from interface com.goldencode.p2j.util.LocalName

getLocalName

Methods inherited from interface com.goldencode.p2j.util.ADMData

getADMData, setADMData, setADMData

Methods inherited from interface com.goldencode.p2j.util.UniqueID

getUniqueID

Methods inherited from interface com.goldencode.p2j.util.NamespaceURI

namespacePrefix, namespacePrefix, namespacePrefix, namespaceURI, namespaceURI, namespaceURI

Method Detail

getActor

character getActor()

Returns the value of the actor attribute for the SOAP-HEADER-ENTRYREF object as a URL. Identifies the recipient of a header element.

Returns:

See above.

isMustUnderstand

logical isMustUnderstand()

Indicates whether a SOAP-HEADER-ENTRYREF object is mandatory (TRUE) or optional (FALSE) for the recipient to process.

Returns:

See above.

deleteHeaderEntry

logical deleteHeaderEntry()

Deletes the XML underlying a SOAP-HEADER-ENTRYREF object, without deleting the object.

Returns:

true if the operation was possible.

setActor

logical setActor(character uri)

Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.

Parameters:

uri - The URI of the SOAP actor.

Returns:

true if the operation was possible.

setActor

logical setActor(java.lang.String uri)

Sets the ACTOR attribute for this SOAP-HEADER-ENTRY.

Parameters:

uri - The URI of the SOAP actor.

Returns:

true if the operation was possible.

setMustUnderstand

logical setMustUnderstand(logical val)

Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.

Parameters:

val - The new value of this attribute.

Returns:

true if the operation was possible.

setMustUnderstand

logical setMustUnderstand(boolean val)

Sets the MUST-UNDERSTAND attribute for this SOAP-HEADER-ENTRY.

Parameters:

val - The new value of this attribute.

Returns:

true if the operation was possible.

setNode

logical setNode(handle xNoderef)

Replaces the underlying XML of a SOAP-HEADER-ENTRYREF object with the DOM XML sub-tree rooted by the X-NODEREF object.

Parameters:

xNoderef - A X-NODEREF variable that refers to the XML that will be set for the SOAP-HEADER-ENTRYREF object.

Returns:

true if the operation was possible.

setSerialized

logical setSerialized(longchar xml)

Sets the SOAP-header-entryref object's underlying XML from serialized XML.

Parameters:

xml - A LONGCHAR variable that contains the XML that will become this SOAP-HEADER-ENTRYREF object. This parameter can be only a longchar, 4GL doesn't allow character variables.

Returns:

true if the operation was possible.