ePages 7.48.0 - DE_EPAGES/Product/API/Table/ProductAvailabilityEmail.pm

Package DE_EPAGES::Product::API::Table::ProductAvailabilityEmail

interface for table ProductAvailabilityEmail

@EXPORT_OK
InsertProductAvailabilityEmail
UpdateProductAvailabilityEmail
DeleteProductAvailabilityEmail
GetAllPKeyProductAvailabilityEmails
GetAllInfoProductAvailabilityEmails
GetInfoProductAvailabilityEmail
ExistsProductAvailabilityEmail
GetPKeyProductAvailabilityEmailsByProductID
GetInfoProductAvailabilityEmailsByProductID
GetPKeyProductAvailabilityEmailsByEMail
GetInfoProductAvailabilityEmailsByEMail
GetPKeyProductAvailabilityEmailsByLocaleID
GetInfoProductAvailabilityEmailsByLocaleID

Functions

DeleteProductAvailabilityEmail
ExistsProductAvailabilityEmail
GetAllInfoProductAvailabilityEmails
GetAllPKeyProductAvailabilityEmails
GetInfoProductAvailabilityEmail
GetInfoProductAvailabilityEmailsByEMail
GetInfoProductAvailabilityEmailsByLocaleID
GetInfoProductAvailabilityEmailsByProductID
GetPKeyProductAvailabilityEmailsByEMail
GetPKeyProductAvailabilityEmailsByLocaleID
GetPKeyProductAvailabilityEmailsByProductID
InsertProductAvailabilityEmail
OnDeleteLocale
UpdateProductAvailabilityEmail

DeleteProductAvailabilityEmail

Deletes a(n) ProductAvailabilityEmail.

Syntax
DeleteProductAvailabilityEmail($ProductID, $EMail);
DeleteProductAvailabilityEmail($hProductAvailabilityEmail); # if $hProductAvailabilityEmail includes ProductID, EMail
Input
$ProductID (int)
product identifier (part of primary key)
$EMail (varchar(150))
email to send availablity information to (part of primary key)

ExistsProductAvailabilityEmail

Returns true if the ProductAvailabilityEmail exists.

Syntax
$exists = ExistsProductAvailabilityEmail($ProductID, $EMail);
Input
$ProductID (int)
product identifier (part of primary key)
$EMail (varchar(150))
email to send availablity information to (part of primary key)
Return
$exists (boolean)
1/0 the ProductAvailabilityEmail exists (yes/no)

GetAllInfoProductAvailabilityEmails

Returns all objects of ProductAvailabilityEmail.

Syntax
$ahProductAvailabilityEmails = GetAllInfoProductAvailabilityEmails();
Return
$ahProductAvailabilityEmails (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

GetAllPKeyProductAvailabilityEmails

Returns all ProductAvailabilityEmail identifiers.

Syntax
$ahProductAvailabilityEmailIDs = GetAllPKeyProductAvailabilityEmails();
Return
$ahProductAvailabilityEmailIDs (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)

GetInfoProductAvailabilityEmail

Returns the ProductAvailabilityEmail by identifier.

Syntax
$hProductAvailabilityEmail = GetInfoProductAvailabilityEmail($ProductID, $EMail);
Input
$ProductID (int)
product identifier (part of primary key)
$EMail (varchar(150))
email to send availablity information to (part of primary key)
Return
$hProductAvailabilityEmail (reference to hash)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

GetInfoProductAvailabilityEmailsByEMail

Returns objects of ProductAvailabilityEmail by alternate key EMail.

Syntax
$ahProductAvailabilityEmails = GetInfoProductAvailabilityEmailsByEMail($EMail);
Input
$EMail (varchar(150))
email to send availablity information to
Return
$ahProductAvailabilityEmails (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

GetInfoProductAvailabilityEmailsByLocaleID

Returns objects of ProductAvailabilityEmail by alternate key LocaleID.

Syntax
$ahProductAvailabilityEmails = GetInfoProductAvailabilityEmailsByLocaleID($LocaleID);
Input
$LocaleID (char(5))
locale id, example en_GB
Return
$ahProductAvailabilityEmails (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

GetInfoProductAvailabilityEmailsByProductID

Returns objects of ProductAvailabilityEmail by primary key element ProductID.

Syntax
$ahProductAvailabilityEmails = GetInfoProductAvailabilityEmailsByProductID($ProductID);
Input
$ProductID (int)
product identifier
Return
$ahProductAvailabilityEmails (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

GetPKeyProductAvailabilityEmailsByEMail

Returns primary keys of ProductAvailabilityEmail by alternate key EMail.

Syntax
$ahKeys = GetPKeyProductAvailabilityEmailsByEMail($EMail);
Input
$EMail (varchar(150))
email to send availablity information to
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)

GetPKeyProductAvailabilityEmailsByLocaleID

Returns primary keys of ProductAvailabilityEmail by alternate key LocaleID.

Syntax
$ahKeys = GetPKeyProductAvailabilityEmailsByLocaleID($LocaleID);
Input
$LocaleID (char(5))
locale id, example en_GB
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)

GetPKeyProductAvailabilityEmailsByProductID

Returns primary keys of ProductAvailabilityEmail by primary key element ProductID.

Syntax
$ahKeys = GetPKeyProductAvailabilityEmailsByProductID($ProductID);
Input
$ProductID (int)
product identifier
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)

InsertProductAvailabilityEmail

Creates an entry of ProductAvailabilityEmail.

Syntax
InsertProductAvailabilityEmail($hProductAvailabilityEmail);
Input
$hProductAvailabilityEmail (reference to hash)
with following keys:
  • ProductID - product identifier (part of primary key)- int
  • EMail - email to send availablity information to (part of primary key)- varchar(150)
  • LocaleID - locale id, example en_GB - char(5)

OnDeleteLocale

Removes all registered email notifications having the locale id, which is to be deleted on site.

Syntax
OnDeleteLocale($hParams);
Input
$hParams (ref.hash.*)
primary key of object Locale, key is
  • Object
  • LocaleID

UpdateProductAvailabilityEmail

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

Syntax
UpdateProductAvailabilityEmail($ProductID, $EMail, $hProductAvailabilityEmail);
UpdateProductAvailabilityEmail($hProductAvailabilityEmail); # if $hProductAvailabilityEmail includes ProductID, EMail
Input
$ProductID (int)
product identifier (part of primary key)
$EMail (varchar(150))
email to send availablity information to (part of primary key)
$hProductAvailabilityEmail (reference to hash)
with following keys:
  • LocaleID - locale id, example en_GB - char(5)