ePages 6.10 - DE_EPAGES/Product/API/Table/ProductPrepayment.pm

Package DE_EPAGES::Product::API::Table::ProductPrepayment

interface for table ProductPrepayment

@EXPORT_OK
InsertProductPrepayment
UpdateProductPrepayment
DeleteProductPrepayment
GetAllPKeyProductPrepayments
GetAllInfoProductPrepayments
GetInfoProductPrepayment
ExistsProductPrepayment
GetPKeyProductPrepaymentsByProductID
GetInfoProductPrepaymentsByProductID
GetPKeyProductPrepaymentsByCurrencyID
GetInfoProductPrepaymentsByCurrencyID

Functions

DeleteProductPrepayment
ExistsProductPrepayment
GetAllInfoProductPrepayments
GetAllPKeyProductPrepayments
GetInfoProductPrepayment
GetInfoProductPrepaymentsByCurrencyID
GetInfoProductPrepaymentsByProductID
GetPKeyProductPrepaymentsByCurrencyID
GetPKeyProductPrepaymentsByProductID
InsertProductPrepayment
OnDeleteCurrency
UpdateProductPrepayment

DeleteProductPrepayment

Deletes a(n) ProductPrepayment.

Syntax
DeleteProductPrepayment($ProductID, $CurrencyID);
DeleteProductPrepayment($hProductPrepayment); # if $hProductPrepayment includes ProductID, CurrencyID
Input
$ProductID (int)
product identifier (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)

ExistsProductPrepayment

Returns true if the ProductPrepayment exists.

Syntax
$exists = ExistsProductPrepayment($ProductID, $CurrencyID);
Input
$ProductID (int)
product identifier
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$exists (boolean)
1/0 the ProductPrepayment exists (yes/no)

GetAllInfoProductPrepayments

Returns all objects of ProductPrepayment.

Syntax
$ahProductPrepayments = GetAllInfoProductPrepayments();
Return
$ahProductPrepayments (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • Value - #Labl[20] - money

GetAllPKeyProductPrepayments

Returns all ProductPrepayment identifiers.

Syntax
$ahProductPrepaymentIDs = GetAllPKeyProductPrepayments();
Return
$ahProductPrepaymentIDs (reference to array of hashes)
with following keys:
  • ProductID - product identifier - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

GetInfoProductPrepayment

Returns the ProductPrepayment by identifier.

Syntax
$hProductPrepayment = GetInfoProductPrepayment($ProductID, $CurrencyID);
Input
$ProductID (int)
product identifier (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)
Return
$hProductPrepayment (reference to hash)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • Value - #Labl[20] - money

GetInfoProductPrepaymentsByCurrencyID

Returns objects of ProductPrepayment by alternate key CurrencyID.

Syntax
$ahProductPrepayments = GetInfoProductPrepaymentsByCurrencyID($CurrencyID);
Input
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$ahProductPrepayments (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • Value - #Labl[20] - money

GetInfoProductPrepaymentsByProductID

Returns objects of ProductPrepayment by primary key element ProductID.

Syntax
$ahProductPrepayments = GetInfoProductPrepaymentsByProductID($ProductID);
Input
$ProductID (int)
product identifier
Return
$ahProductPrepayments (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • Value - #Labl[20] - money

GetPKeyProductPrepaymentsByCurrencyID

Returns primary keys of ProductPrepayment by alternate key CurrencyID.

Syntax
$ahKeys = GetPKeyProductPrepaymentsByCurrencyID($CurrencyID);
Input
$CurrencyID (char(3))
alpha currency code (ISO 4217)
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID - product identifier - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

GetPKeyProductPrepaymentsByProductID

Returns primary keys of ProductPrepayment by primary key element ProductID.

Syntax
$ahKeys = GetPKeyProductPrepaymentsByProductID($ProductID);
Input
$ProductID (int)
product identifier
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID - product identifier - int
  • CurrencyID - alpha currency code (ISO 4217) - char(3)

InsertProductPrepayment

Creates an entry of ProductPrepayment.

Syntax
InsertProductPrepayment($hProductPrepayment);
Input
$hProductPrepayment (reference to hash)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • CurrencyID - alpha currency code (ISO 4217) (part of primary key)- char(3)
  • Value - #Labl[20] - money

OnDeleteCurrency

Deletes ProductPrepayment of this model when a(n) Currency is deleted.

Syntax
OnDeleteCurrency($hParams);
Input
$hParams (ref.hash.*)
primary key of object Currency, key is
  • CurrencyID

UpdateProductPrepayment

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

Syntax
UpdateProductPrepayment($ProductID, $CurrencyID, $hProductPrepayment);
UpdateProductPrepayment($hProductPrepayment); # if $hProductPrepayment includes ProductID, CurrencyID
Input
$ProductID (int)
product identifier (part of primary key)
$CurrencyID (char(3))
alpha currency code (ISO 4217) (part of primary key)
$hProductPrepayment (reference to hash)
with following keys:
  • Value - #Labl[20] - money