ePages 6.11.0 - DE_EPAGES/ShopConfiguration/API/Table/StoreCartridge.pm

Package DE_EPAGES::ShopConfiguration::API::Table::StoreCartridge

interface for table StoreCartridge

@EXPORT_OK
InsertStoreCartridge
UpdateStoreCartridge
DeleteStoreCartridge
GetAllPKeyStoreCartridges
GetAllInfoStoreCartridges
GetInfoStoreCartridge
ExistsStoreCartridge
GetPKeyStoreCartridgesByStoreID
GetInfoStoreCartridgesByStoreID
GetPKeyStoreCartridgesByCartridgeID
GetInfoStoreCartridgesByCartridgeID

Functions

DeleteStoreCartridge
ExistsStoreCartridge
GetAllInfoStoreCartridges
GetAllPKeyStoreCartridges
GetInfoStoreCartridge
GetInfoStoreCartridgesByCartridgeID
GetInfoStoreCartridgesByStoreID
GetPKeyStoreCartridgesByCartridgeID
GetPKeyStoreCartridgesByStoreID
InsertStoreCartridge
OnDeleteStore
UpdateStoreCartridge

DeleteStoreCartridge

Deletes a(n) StoreCartridge.

Syntax
DeleteStoreCartridge($StoreID, $CartridgeID);
DeleteStoreCartridge($hStoreCartridge); # if $hStoreCartridge includes StoreID, CartridgeID
Input
$StoreID (integer)
store identifier (part of primary key)
$CartridgeID (int)
cartridge id (part of primary key)

ExistsStoreCartridge

Returns true if the StoreCartridge exists.

Syntax
$exists = ExistsStoreCartridge($StoreID, $CartridgeID);
Input
$StoreID (integer)
store identifier
$CartridgeID (int)
cartridge id
Return
$exists (boolean)
1/0 the StoreCartridge exists (yes/no)

GetAllInfoStoreCartridges

Returns all objects of StoreCartridge.

Syntax
$ahStoreCartridgeIDs = GetAllInfoStoreCartridges();
Return
$ahStoreCartridgeIDs (reference to array of hashes)
with following keys:
  • StoreID - store identifier (part of primary key)- integer
  • CartridgeID - cartridge id (part of primary key)- int
  • Version - cartridge version - varchar(30)

GetAllPKeyStoreCartridges

Returns all StoreCartridge identifiers.

Syntax
$ahStoreCartridgeIDs = GetAllPKeyStoreCartridges();
Return
$ahStoreCartridgeIDs (reference to array of hashes)
with following keys:
  • StoreID - store identifier - integer
  • CartridgeID - cartridge id - int

GetInfoStoreCartridge

Returns the StoreCartridge by identifier.

Syntax
$hStoreCartridge = GetInfoStoreCartridge($StoreID, $CartridgeID);
Input
$StoreID (integer)
store identifier (part of primary key)
$CartridgeID (int)
cartridge id (part of primary key)
Return
$hStoreCartridge (reference to hash)
with following keys:
  • StoreID - store identifier (part of primary key)- integer
  • CartridgeID - cartridge id (part of primary key)- int
  • Version - cartridge version - varchar(30)

GetInfoStoreCartridgesByCartridgeID

Returns objects of StoreCartridge by alternate key CartridgeID.

Syntax
$ahStoreCartridges = GetInfoStoreCartridgesByCartridgeID($CartridgeID);
Input
$CartridgeID (int)
cartridge id
Return
$ahStoreCartridges (reference to array of hashes)
with following keys:
  • StoreID - store identifier (part of primary key)- integer
  • CartridgeID - cartridge id (part of primary key)- int
  • Version - cartridge version - varchar(30)

GetInfoStoreCartridgesByStoreID

Returns objects of StoreCartridge by primary key element StoreID.

Syntax
$ahStoreCartridges = GetInfoStoreCartridgesByStoreID($StoreID);
Input
$StoreID (integer)
store identifier
Return
$ahStoreCartridges (reference to array of hashes)
with following keys:
  • StoreID - store identifier (part of primary key)- integer
  • CartridgeID - cartridge id (part of primary key)- int
  • Version - cartridge version - varchar(30)

GetPKeyStoreCartridgesByCartridgeID

Returns primary keys of StoreCartridge by alternate key CartridgeID.

Syntax
$ahKeys = GetPKeyStoreCartridgesByCartridgeID($CartridgeID);
Input
$CartridgeID (int)
cartridge id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • StoreID - store identifier - integer
  • CartridgeID - cartridge id - int

GetPKeyStoreCartridgesByStoreID

Returns primary keys of StoreCartridge by primary key element StoreID.

Syntax
$ahKeys = GetPKeyStoreCartridgesByStoreID($StoreID);
Input
$StoreID (integer)
store identifier
Return
$ahKeys (reference to array of hashes)
with following keys:
  • StoreID - store identifier - integer
  • CartridgeID - cartridge id - int

InsertStoreCartridge

Creates an entry of StoreCartridge.

Syntax
InsertStoreCartridge($hStoreCartridge);
Input
$hStoreCartridge (reference to hash)
with following keys:
  • StoreID - store identifier (part of primary key)- integer
  • CartridgeID - cartridge id (part of primary key)- int
  • Version - cartridge version - varchar(30)

OnDeleteStore

Deletes StoreCartridge of this model when a(n) Store is deleted.

Syntax
OnDeleteStore($hParams);
Input
$hParams (ref.hash.*)
primary key of object Store, key is
  • StoreID

UpdateStoreCartridge

Updates a(n) StoreCartridge if any element was changed.

Syntax
UpdateStoreCartridge($StoreID, $CartridgeID, $hStoreCartridge);
UpdateStoreCartridge($hStoreCartridge); # if $hStoreCartridge includes StoreID, CartridgeID
Input
$StoreID (integer)
store identifier (part of primary key)
$CartridgeID (int)
cartridge id (part of primary key)
$hStoreCartridge (reference to hash)
with following keys:
  • Version - cartridge version - varchar(30)
Return
1 (integer)
1