ePages 6.11.0 - DE_EPAGES/Cartridge/API/Table/Cartridge.pm

Package DE_EPAGES::Cartridge::API::Table::Cartridge

interface for table Cartridge

@EXPORT_OK
InsertCartridge
UpdateCartridge
DeleteCartridge
GetAllPKeyCartridges
GetAllInfoCartridges
GetInfoCartridge
ExistsCartridge
GetPKeyCartridgeByPackage
GetInfoCartridgeByPackage
ExistsCartridgeByPackage
GetPKeyCartridgesByPackage
GetInfoCartridgesByPackage

Functions

DeleteCartridge
ExistsCartridge
ExistsCartridgeByPackage
GetAllInfoCartridges
GetAllPKeyCartridges
GetInfoCartridge
GetInfoCartridgeByPackage
GetInfoCartridgesByPackage
GetPKeyCartridgeByPackage
GetPKeyCartridgesByPackage
InsertCartridge
UpdateCartridge

DeleteCartridge

Deletes a(n) Cartridge.

Syntax
DeleteCartridge($CartridgeID);
DeleteCartridge($hCartridge); # if $hCartridge includes CartridgeID
Input
$CartridgeID (int)
cartridge identifier (primary key)

ExistsCartridge

Returns true if the Cartridge exists.

Syntax
$exists = ExistsCartridge($CartridgeID);
Input
$CartridgeID (int)
cartridge identifier
Return
$exists (boolean)
1/0 the Cartridge exists (yes/no)

ExistsCartridgeByPackage

Returns true if a Cartridge by alternate key Package exists.

Syntax
$CartridgeID = ExistsCartridgeByPackage($Package);
Input
$Package (varchar(255))
perl package name (eg: DE_EPAGES::Cartridge)
Return
$exists (boolean)
1/0 the u_cartridge exists (yes/no)

GetAllInfoCartridges

Returns all objects of Cartridge.

Syntax
$ahCartridgeIDs = GetAllInfoCartridges();
Return
$ahCartridgeIDs (reference to array of hashes)
with following keys:
  • CartridgeID - cartridge identifier (primary key)- int
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)

GetAllPKeyCartridges

Returns all Cartridge identifiers.

Syntax
$aCartridgeIDs = GetAllPKeyCartridges();
Return
$aCartridgeIDs (reference to array of int)
cartridge identifier

GetInfoCartridge

Returns the Cartridge by identifier.

Syntax
$hCartridge = GetInfoCartridge($CartridgeID);
Input
$CartridgeID (int)
cartridge identifier (primary key)
Return
$hCartridge (reference to hash)
with following keys:
  • CartridgeID - cartridge identifier (primary key)- int
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)

GetInfoCartridgeByPackage

Returns the object of Cartridge by alternate key Package.

Syntax
$hCartridge = GetInfoCartridgeByPackage($Package);
Input
$Package (varchar(255))
perl package name (eg: DE_EPAGES::Cartridge)
Return
$hCartridge (reference to hash)
with following keys:
  • CartridgeID - cartridge identifier (primary key)- int
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)

GetInfoCartridgesByPackage

Returns objects of Cartridge by alternate key Package.

Syntax
$ahCartridges = GetInfoCartridgesByPackage($Package);
Input
$Package (varchar(255))
perl package name (eg: DE_EPAGES::Cartridge)
Return
$ahCartridges (reference to array of hashes)
with following keys:
  • CartridgeID - cartridge identifier (primary key)- int
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)

GetPKeyCartridgeByPackage

Returns primary key of Cartridge by alternate key Package.

Syntax
$CartridgeID = GetPKeyCartridgeByPackage($Package);
Input
$Package (varchar(255))
perl package name (eg: DE_EPAGES::Cartridge)
Return
$CartridgeID (int)
cartridge identifier (primary key)

GetPKeyCartridgesByPackage

Returns primary keys of Cartridge by alternate key Package.

Syntax
$aKeys = GetPKeyCartridgesByPackage($Package);
Input
$Package (varchar(255))
perl package name (eg: DE_EPAGES::Cartridge)
Return
$aKeys (reference to array of int)
cartridge identifier (primary key)

InsertCartridge

Creates an entry of Cartridge.

Syntax
$CartridgeID = InsertCartridge($hCartridge);
Input
$hCartridge (reference to hash)
with following keys:
  • CartridgeID - cartridge identifier (primary key)(optional)- int
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)
Return
$CartridgeID (int)
cartridge identifier (primary key)

UpdateCartridge

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

Syntax
UpdateCartridge($CartridgeID, $hCartridge);
UpdateCartridge($hCartridge); # if $hCartridge includes CartridgeID
Input
$CartridgeID (int)
cartridge identifier (primary key)
$hCartridge (reference to hash)
with following keys:
  • Package - perl package name (eg: DE_EPAGES::Cartridge) - varchar(255)
  • Version - current installed cartridge version, to compare with perl cartridge version - varchar(30)
  • InstallState - is cartridge installed0 - not installed1 - on install process2 - installed3 - on deinstall process4 - on patch process5 - on patch structure process - tinyint
  • DBStructureVersion - db structure version during patch process - varchar(30)