ePages 6.10 - DE_EPAGES/ShopConfiguration/API/Object/ShopType.pm

Package DE_EPAGES::ShopConfiguration::API::Object::ShopType

object interface for ShopType.

Base
DE_EPAGES::ShopConfiguration::API::Object::FeatureCollection

Functions

addFeaturePack
className
dbPackage
exportXMLElements
featurePacks
hasFeaturePack
removeFeaturePack
shops

addFeaturePack

Makes a feature pack available for this shop type.

Syntax
$ShopType->addFeaturePack( $FeaturePack );
Input
$FeaturePack (object)
feature pack object

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $ShopType->className;
Return
$ClassName (String)
class name

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $ShopType->dbPackage;
Return
$DbPackage (String)
database package name

exportXMLElements

Exports multilinguagal attribute value of this object to the xml SAX driver.

Syntax
$Object->exportXMLElements($Driver, $hAllAttributes);
Input
$Driver (object)
export driver
$hAllAttributes (ref.hash)
all attributes of object,
see $Object->allAttributes

featurePacks

Returns a list of feature packs that are available for this shop type.

Syntax
$aFeaturePacks = $ShopType->featurePacks;
Example
$ShopType->removeFeaturePack( $_ ) foreach @{ $ShopType->featurePacks };
Return
$aFeaturePacks (ref.array.object)
list of feature pack objects

hasFeaturePack

Returns true if the feature pack is available for this shop type.

Syntax
$Exists = $ShopType->hasFeaturePack( $FeaturePack );
Example
$ShopType->removeFeaturePack( $FeaturePack ) if $ShopType->hasFeaturePack( $FeaturePack );
Input
$FeaturePack (object)
feature pack object
Return
$Exists (boolean)
true if the feature pack is available

removeFeaturePack

Removes a feature pack available for this shop type.

Syntax
$ShopType->removeFeaturePack( $FeaturePack );
Input
$FeaturePack (object)
feature pack object

shops

Returns all shops of this shop type.

Syntax
$aShops = $ShopType->shops;
Input
$aShops (ref.array.object)
list of shop reference objects