ePages 6.17.43 - DE_EPAGES/MeinPaket/API/DTO/DownloadResponse.pm

Package DE_EPAGES::MeinPaket::API::DTO::DownloadResponse

DTO Class for data structure DownloadResponse

Base
DE_EPAGES::MeinPaket::API::DTO::DTO

Functions

CategoryHash
ErrorList
VariantConfigurationArray
addCategory
addVariantConfiguration
getCategory
popError
pushError
rootCategory
toXML

CategoryHash

returns 'Category' hash

Syntax
$Object->CategoryHash();
Return
$hCategories (any.hash.ref)
hash of Category elements

ErrorList

returns list of 'Error' elements

Syntax
$Object->ErrorList();
Return
$ErrorList (any.array.ref)
element list of Error

VariantConfigurationArray

returns 'VariantConfiguration' array

Syntax
$Object->VariantConfigurationArray();
Return
$aVariantConfigurations (any.hash.ref)
array of VariantConfiguration elements

addCategory

pushes 'Category' to hash

Syntax
$Object->addCategory($Key, $Element);
Input
$Key (string)
hash key
$Category (any)
value of Category

addVariantConfiguration

pushes 'VariantConfiguration' to array

Syntax
$Object->addVariantConfiguration($Element);
Input
$VariantConfiguration (any)
VariantConfiguration

getCategory

gets 'Category' from hash

Syntax
$Object->getCategory($key);
Input
$Key (string)
hash key
Return
$Category (any)
Category

popError

pops 'Error' from stack

Syntax
$Object->popError();
Return
$Error (any)
last element of Error

pushError

pushes 'Error' on stack

Syntax
$Object->pushError($Element);
Input
$Error (any)
value of Error

rootCategory

getter/setter for 'rootCategory'

Syntax
my $rootCategory = $Object->rootCategory;
$Object->rootCategory('value');
Input
$rootCategory (any)
value of rootCategory
Return
$rootCategory (any)
value of rootCategory

toXML

XML serialization of object

Syntax
$Object->toXML();
Return
$xml (string)
serialized version of object as xml string