ePages 7.1.0 - DE_EPAGES/MeinPaket/API/DTO/Category.pm

Package DE_EPAGES::MeinPaket::API::DTO::Category

DTO Class for data structure Category

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

Functions

CategoryAttributeHash
addCategoryAttribute
addChild
children
code
deprecated
getCategoryAttribute
isLeaf
level
name
orphaned
parent
parentCode
shortDescription
toXML

CategoryAttributeHash

returns 'CategoryAttribute' hash

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

addCategoryAttribute

pushes 'CategoryAttribute' to hash

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

addChild

pushes 'Child' on stack

Syntax
$Object->addChild($Element);
Input
$Child (any)
value of Child

children

returns list of 'Child' elements

Syntax
$Object->children();
Return
$ChildList (any.array.ref)
element list of Child

code

getter/setter for 'code'

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

deprecated

getter/setter for 'deprecated'

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

getCategoryAttribute

gets 'CategoryAttribute' from hash

Syntax
$Object->getCategoryAttribute($key);
Input
$Key (string)
hash key
Return
$CategoryAttribute (any)
CategoryAttribute

isLeaf

getter/setter for 'isLeaf'

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

level

getter/setter for 'level'

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

name

getter/setter for 'name'

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

orphaned

getter/setter for 'orphaned'

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

parent

getter/setter for 'parent'

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

parentCode

getter/setter for 'parentCode'

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

shortDescription

getter/setter for 'shortDescription'

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

toXML

XML serialization of object

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