ePages 6.10 - DE_EPAGES/ShopConfiguration/API/Table/CartridgeRef.pm

Package DE_EPAGES::ShopConfiguration::API::Table::CartridgeRef

interface for table CartridgeRef

@EXPORT_OK
InsertCartridgeRef
UpdateCartridgeRef
DeleteCartridgeRef
GetAllPKeyCartridgeRefs
GetAllInfoCartridgeRefs
GetInfoCartridgeRef
ExistsCartridgeRef
GetPKeyCartridgeRefByPackage
GetInfoCartridgeRefByPackage
ExistsCartridgeRefByPackage
GetPKeyCartridgeRefsByPackage
GetInfoCartridgeRefsByPackage

Functions

DeleteCartridgeRef
ExistsCartridgeRef
ExistsCartridgeRefByPackage
GetAllInfoCartridgeRefs
GetAllPKeyCartridgeRefs
GetInfoCartridgeRef
GetInfoCartridgeRefByPackage
GetInfoCartridgeRefsByPackage
GetPKeyCartridgeRefByPackage
GetPKeyCartridgeRefsByPackage
InsertCartridgeRef
UpdateCartridgeRef

DeleteCartridgeRef

Deletes a(n) CartridgeRef.

Syntax
DeleteCartridgeRef($CartridgeID);
DeleteCartridgeRef($hCartridgeRef); # if $hCartridgeRef includes CartridgeID
Input
$CartridgeID (int)
cartridge id (primary key)

ExistsCartridgeRef

Returns true if the CartridgeRef exists.

Syntax
$exists = ExistsCartridgeRef($CartridgeID);
Input
$CartridgeID (int)
cartridge id
Return
$exists (boolean)
1/0 the CartridgeRef exists (yes/no)

ExistsCartridgeRefByPackage

Returns true if a CartridgeRef by alternate key Package exists.

Syntax
$CartridgeID = ExistsCartridgeRefByPackage($Package);
Input
$Package (varchar(255))
cartridge package name
Return
$exists (boolean)
1/0 the u_cartridgeref_package exists (yes/no)

GetAllInfoCartridgeRefs

Returns all objects of CartridgeRef.

Syntax
$ahCartridgeRefs = GetAllInfoCartridgeRefs();
Return
$ahCartridgeRefs (reference to array of hashes)
with following keys:
  • CartridgeID - cartridge id (primary key)- int
  • Package - cartridge package name - varchar(255)

GetAllPKeyCartridgeRefs

Returns all CartridgeRef identifiers.

Syntax
$aCartridgeRefIDs = GetAllPKeyCartridgeRefs();
Return
$aCartridgeRefIDs (reference to array of int)
cartridge id

GetInfoCartridgeRef

Returns the CartridgeRef by identifier.

Syntax
$hCartridgeRef = GetInfoCartridgeRef($CartridgeID);
Input
$CartridgeID (int)
cartridge id (primary key)
Return
$hCartridgeRef (reference to hash)
with following keys:
  • CartridgeID - cartridge id (primary key)- int
  • Package - cartridge package name - varchar(255)

GetInfoCartridgeRefByPackage

Returns the object of CartridgeRef by alternate key Package.

Syntax
$hCartridgeRef = GetInfoCartridgeRefByPackage($Package);
Input
$Package (varchar(255))
cartridge package name
Return
$hCartridgeRef (reference to hash)
with following keys:
  • CartridgeID - cartridge id (primary key)- int
  • Package - cartridge package name - varchar(255)

GetInfoCartridgeRefsByPackage

Returns objects of CartridgeRef by alternate key Package.

Syntax
$ahCartridgeRefs = GetInfoCartridgeRefsByPackage($Package);
Input
$Package (varchar(255))
cartridge package name
Return
$ahCartridgeRefs (reference to array of hashes)
with following keys:
  • CartridgeID - cartridge id (primary key)- int
  • Package - cartridge package name - varchar(255)

GetPKeyCartridgeRefByPackage

Returns primary key of CartridgeRef by alternate key Package.

Syntax
$CartridgeID = GetPKeyCartridgeRefByPackage($Package);
Input
$Package (varchar(255))
cartridge package name
Return
$CartridgeID (int)
cartridge id (primary key)

GetPKeyCartridgeRefsByPackage

Returns primary keys of CartridgeRef by alternate key Package.

Syntax
$aKeys = GetPKeyCartridgeRefsByPackage($Package);
Input
$Package (varchar(255))
cartridge package name
Return
$aKeys (reference to array of int)
cartridge id (primary key)

InsertCartridgeRef

Creates an entry of CartridgeRef.

Syntax
$CartridgeID = InsertCartridgeRef($hCartridgeRef);
Input
$hCartridgeRef (reference to hash)
with following keys:
  • CartridgeID - cartridge id (primary key)(optional)- int
  • Package - cartridge package name - varchar(255)
Return
$CartridgeID (int)
cartridge id (primary key)

UpdateCartridgeRef

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

Syntax
UpdateCartridgeRef($CartridgeID, $hCartridgeRef);
UpdateCartridgeRef($hCartridgeRef); # if $hCartridgeRef includes CartridgeID
Input
$CartridgeID (int)
cartridge id (primary key)
$hCartridgeRef (reference to hash)
with following keys:
  • Package - cartridge package name - varchar(255)