ePages 6.17.48 - DE_EPAGES/ShopConfiguration/API/Object/ShopRef.pm

Package DE_EPAGES::ShopConfiguration::API::Object::ShopRef

object interface for ShopRef.

Base
DE_EPAGES::Object::API::Object::Object

Functions

activeFeatureCollections
addAttribute
addFeaturePack
applyFeatureValues
className
createRemoteShop
dbPackage
deleteRemoteShop
existsAttribute
existsRemoteShop
exportRemoteShop
exportXMLElements
featureCollections
features
registerUnity
remoteShop
setShopType
shopRefClass

activeFeatureCollections

Returns all feature collections that are used by the shop.

Syntax
$aCollections = $Shop->activeFeatureCollections
Return
$aCollections (ref.array.object)
list of shop feature collection objects

addAttribute

Use: $self->addAttribute( 'Channel', 'String' } );

Syntax
$self->addAttribute( $Name, $Type );
Input
$Name (string)
attribute name
$Type (type)
attribute
Return
$Attribute (object)
added attribute object

addFeaturePack

Adds a feature pack to a shop.

Syntax
$Shop->addFeaturePack( $FeaturePack );
Example
$Shop->addFeaturePack( $FeaturePack );
$Shop->applyFeatureValues;
Input
$FeaturePack (object)
feature pack object
Return
$FeaturePack (object)
shop feature collection object

applyFeatureValues

Saves all features (stored at Site) in database of shop.

Syntax
$ShopRef->applyFeatureValues;

className

Returns the class name, used for DAL access.

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

createRemoteShop

creates a new shop, based to this shop reference. Options see DE_EPAGES::ShopConfiguration::API::Object::RemoteShop::create.

Syntax
$ShopRef->createRemoteShop($hOptions);
Input
$hOptions (ref.hash)
shop data

dbPackage

Returns the database package, used for DAL access.

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

deleteRemoteShop

removes shop, based to this shop reference. Deactivate all active Feature Collections. Mark is closed by service provider and deletes shop DE_EPAGES::ShopConfiguration::API::Object::RemoteShop::delete. After this set IsDeleted=1, DomainName=undef, StoreObjectPath=undef, StoreobjectID = undef. This is done also if the shop does not exist at the store anymore.

Syntax
$ShopRef->deleteRemoteShop;

existsAttribute

$self->existsAttribute( $Name ); to check if an attribute with this name still exists

Syntax
$self->existsAttribute( $Name );
Example
if( $ShopRef->existsAttribute( 'Channel' ) )
Input
$Name (string)
attribute name
Return
$bExists (boolean)
returns true if attribute still exists
but return false if not

existsRemoteShop

Returns true if the remote shop object with the StoreObjectID exists

Syntax
$ExistsRemoteShop = $ShopRef->existsRemoteShop;
Return
$Exists (boolean)
true if the object exists

exportRemoteShop

export shop, based to this shop reference. DE_EPAGES::ShopConfiguration::API::Object::RemoteShop::export.

Syntax
$ShopRef->exportRemoteShop;

exportXMLElements

export xml data to export multilinguagal properties of this object.

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

featureCollections

Returns all feature collections that are or were used by the shop.

Syntax
$aCollections = $Shop->featureCollections
Return
$aCollections (ref.array.object)
list of shop feature collection objects

features

Returns all features of a shop.

Syntax
$aFeatures = $Shop->features
Return
$ahFeatures (ref.array.hash)
list of hashes. each hash contains:
  • FeatureRef - FeatureRef -object
  • MaxValue - Allowed feature value for the shop -integer

registerUnity

Registers an Unity shop, based to this shop reference. DE_EPAGES::ShopConfiguration::API::Object::RemoteShop::registerUnity.

Syntax
$ShopRef->registerUnity;

remoteShop

Returns the remote shop see DE_EPAGES::ShopConfiguration::API::Object::RemoteShop.

Syntax
$RemoteShop = $ShopRef->remoteShop;
Return
$RemoteShop (object)
web service contacted shop

setShopType

Obsolete. Use: $self->set( { ShopType => $ShopType } );

Syntax
$self->setShopType( $ShopType );
Input
$ShopType (object)
new shop type

shopRefClass

Returns a shop reference class of a provider with own shop ref class different to system shop ref class. switch to that class if current one different

Syntax
$ShopRefClass = $ShopRef->shopRefClass();
Return
$ShopRefClass (object)
shop reference class object