ePages 6.10 - DE_EPAGES/Ekomi/API/Table/EkomiRating.pm

Package DE_EPAGES::Ekomi::API::Table::EkomiRating

interface for table EkomiRating

@EXPORT_OK
InsertEkomiRating
UpdateEkomiRating
DeleteEkomiRating
GetAllPKeyEkomiRatings
GetAllInfoEkomiRatings
GetInfoEkomiRating
ExistsEkomiRating
GetPKeyEkomiRatingsByShopID
GetInfoEkomiRatingsByShopID
GetPKeyEkomiRatingsByUserID
GetInfoEkomiRatingsByUserID

Functions

DeleteEkomiRating
ExistsEkomiRating
GetAllInfoEkomiRatings
GetAllPKeyEkomiRatings
GetInfoEkomiRating
GetInfoEkomiRatingsByShopID
GetInfoEkomiRatingsByUserID
GetPKeyEkomiRatingsByShopID
GetPKeyEkomiRatingsByUserID
InsertEkomiRating
UpdateEkomiRating

DeleteEkomiRating

Deletes a(n) EkomiRating.

Syntax
DeleteEkomiRating($OrderID);
DeleteEkomiRating($hEkomiRating); # if $hEkomiRating includes OrderID
Input
$OrderID (int)
object identifier (primary key)

ExistsEkomiRating

Returns true if the EkomiRating exists.

Syntax
$exists = ExistsEkomiRating($OrderID);
Input
$OrderID (int)
object identifier
Return
$exists (boolean)
1/0 the EkomiRating exists (yes/no)

GetAllInfoEkomiRatings

Returns all objects of EkomiRating.

Syntax
$ahEkomiRatingIDs = GetAllInfoEkomiRatings();
Return
$ahEkomiRatingIDs (reference to array of hashes)
with following keys:
  • OrderID - object identifier (primary key)- int
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime

GetAllPKeyEkomiRatings

Returns all EkomiRating identifiers.

Syntax
$aEkomiRatingIDs = GetAllPKeyEkomiRatings();
Return
$aEkomiRatingIDs (reference to array of int)
object identifier

GetInfoEkomiRating

Returns the EkomiRating by identifier.

Syntax
$hEkomiRating = GetInfoEkomiRating($OrderID);
Input
$OrderID (int)
object identifier (primary key)
Return
$hEkomiRating (reference to hash)
with following keys:
  • OrderID - object identifier (primary key)- int
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime

GetInfoEkomiRatingsByShopID

Returns objects of EkomiRating by alternate keys ShopID and DispatchedOn.

Syntax
$ahEkomiRatings = GetInfoEkomiRatingsByShopID($ShopID, $DispatchedOn);
Input
$ShopID (int)
shop id
$DispatchedOn (datetime)
dispatched date (optional)
Return
$ahEkomiRatings (reference to array of hashes)
with following keys:
  • OrderID - object identifier (primary key)- int
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime

GetInfoEkomiRatingsByUserID

Returns objects of EkomiRating by alternate key UserID.

Syntax
$ahEkomiRatings = GetInfoEkomiRatingsByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahEkomiRatings (reference to array of hashes)
with following keys:
  • OrderID - object identifier (primary key)- int
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime

GetPKeyEkomiRatingsByShopID

Returns primary keys of EkomiRating by alternate keys ShopID and DispatchedOn.

Syntax
$aKeys = GetPKeyEkomiRatingsByShopID($ShopID, $DispatchedOn);
Input
$ShopID (int)
shop id
$DispatchedOn (datetime)
dispatched date (optional)
Return
$aKeys (reference to array of int)
object identifier (primary key)

GetPKeyEkomiRatingsByUserID

Returns primary keys of EkomiRating by alternate key UserID.

Syntax
$aKeys = GetPKeyEkomiRatingsByUserID($UserID);
Input
$UserID (int)
user id
Return
$aKeys (reference to array of int)
object identifier (primary key)

InsertEkomiRating

Creates an entry of EkomiRating.

Syntax
InsertEkomiRating($hEkomiRating);
Input
$hEkomiRating (reference to hash)
with following keys:
  • OrderID - object identifier (primary key)- int
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime

UpdateEkomiRating

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

Syntax
UpdateEkomiRating($OrderID, $hEkomiRating);
UpdateEkomiRating($hEkomiRating); # if $hEkomiRating includes OrderID
Input
$OrderID (int)
object identifier (primary key)
$hEkomiRating (reference to hash)
with following keys:
  • ShopID - shop id - int
  • UserID - user id (optional)- int
  • DispatchedOn - dispatched date - datetime