ePages 6.17.48 - DE_EPAGES/USPS/API/WebServices/Base/XMLrequest.pm

Package DE_EPAGES::USPS::API::WebServices::Base::XMLrequest

It holds common request operations

Functions

getAPInodeEnumValues
getXMLrequestNode
initializeRequest
isValidRequestOrError
new
setNodeAttribute
setTextNodeWithinXMLrequest
toString

getAPInodeEnumValues

It returns an array with values from "EnumValue" child tags.

Syntax
$aEnumValues = $self->getAPInodeEnumValues($APInode);
Input
$APInode (object)
API node object
Return
(array ref)
$aEnumValues

getXMLrequestNode

It provides the XML node provided by name.

Syntax
$foundNode = $self->getXMLrequestNode($nodeName, $XMLnode);
Input
$nodeName (string)
XML node name
$XMLnode (object)
XML node object to look into
Return
$foundNode (object)
XML node object

initializeRequest

It initializes XML DOM node tree from API DOM.

Syntax
$self->initializeRequest();

isValidRequestOrError

It checks if internal XML (DOM) object request is valid by reviewing API (DOM) structure. It throws an error if XML is not valid.

Syntax
$isValid = $self->isValidRequestOrError();
Return
(boolean)
$isValid

new

Creates a new XMLrequest object .

Syntax
$XMLrequest = DE_EPAGES::USPS::API::WebServices::Base::XMLrequest->new($APIrequest);
Input
$APIrequest (hash ref)
API request hash structure
Return
$XMLrequest (object)
XMLrequest object

setNodeAttribute

It sets a value into an attribute for the specified node.

Syntax
$self->setNodeAttribute( $attributeName, $attributeValue, $XMLnode );
Input
$attributeName (string)
attribute name for the provided node
$attributeValue (string)
attribute text value
$XMLnode (object)
XML node object

setTextNodeWithinXMLrequest

It replaces the current text value of an XML DOM node.

Syntax
$self->setTextNodeWithinXMLrequest($nodeName, $textValue);
Input
$nodeName (string)
node name to be found into XML DOM
$textValue (string)
replacement text value
$XMLnode (object)
XML node object

toString

return string representing XML DOM hold in the object.

Syntax
$XMLstring = $self->toString();
Return
$XMLstring (string)
XML DOM string