ePages 6.10 - DE_EPAGES/Ebay/API/Table/EbayRegion.pm

Package DE_EPAGES::Ebay::API::Table::EbayRegion

interface for table EbayRegion

@EXPORT_OK
InsertEbayRegion
UpdateEbayRegion
DeleteEbayRegion
GetAllPKeyEbayRegions
GetAllInfoEbayRegions
GetInfoEbayRegion
ExistsEbayRegion
GetPKeyEbayRegionsByCountryID
GetInfoEbayRegionsByCountryID

Functions

DeleteEbayRegion
ExistsEbayRegion
GetAllInfoEbayRegions
GetAllPKeyEbayRegions
GetInfoEbayRegion
GetInfoEbayRegionsByCountryID
GetPKeyEbayRegionsByCountryID
InsertEbayRegion
OnDeleteCountry
UpdateEbayRegion

DeleteEbayRegion

Deletes a(n) EbayRegion.

Syntax
DeleteEbayRegion($EbayRegionId);
DeleteEbayRegion($hEbayRegion); # if $hEbayRegion includes EbayRegionId
Input
$EbayRegionId (int)
eBay's RegionId (primary key)

ExistsEbayRegion

Returns true if the EbayRegion exists.

Syntax
$exists = ExistsEbayRegion($EbayRegionId);
Input
$EbayRegionId (int)
eBay's RegionId
Return
$exists (boolean)
1/0 the EbayRegion exists (yes/no)

GetAllInfoEbayRegions

Returns all objects of EbayRegion.

Syntax
$ahEbayRegions = GetAllInfoEbayRegions();
Return
$ahEbayRegions (reference to array of hashes)
with following keys:
  • EbayRegionId - eBay's RegionId (primary key)- int
  • CountryID - country identifier - iso num code - int
  • Name - eBay's Region Name - nvarchar(255)

GetAllPKeyEbayRegions

Returns all EbayRegion identifiers.

Syntax
$aEbayRegionIDs = GetAllPKeyEbayRegions();
Return
$aEbayRegionIDs (reference to array of int)
eBay's RegionId

GetInfoEbayRegion

Returns the EbayRegion by identifier.

Syntax
$hEbayRegion = GetInfoEbayRegion($EbayRegionId);
Input
$EbayRegionId (int)
eBay's RegionId (primary key)
Return
$hEbayRegion (reference to hash)
with following keys:
  • EbayRegionId - eBay's RegionId (primary key)- int
  • CountryID - country identifier - iso num code - int
  • Name - eBay's Region Name - nvarchar(255)

GetInfoEbayRegionsByCountryID

Returns objects of EbayRegion by alternate key CountryID.

Syntax
$ahEbayRegions = GetInfoEbayRegionsByCountryID($CountryID);
Input
$CountryID (int)
country identifier - iso num code
Return
$ahEbayRegions (reference to array of hashes)
with following keys:
  • EbayRegionId - eBay's RegionId (primary key)- int
  • CountryID - country identifier - iso num code - int
  • Name - eBay's Region Name - nvarchar(255)

GetPKeyEbayRegionsByCountryID

Returns primary keys of EbayRegion by alternate key CountryID.

Syntax
$aKeys = GetPKeyEbayRegionsByCountryID($CountryID);
Input
$CountryID (int)
country identifier - iso num code
Return
$aKeys (reference to array of int)
eBay's RegionId (primary key)

InsertEbayRegion

Creates an entry of EbayRegion.

Syntax
InsertEbayRegion($hEbayRegion);
Input
$hEbayRegion (reference to hash)
with following keys:
  • EbayRegionId - eBay's RegionId (primary key)- int
  • CountryID - country identifier - iso num code - int
  • Name - eBay's Region Name - nvarchar(255)

OnDeleteCountry

Deletes EbayRegion of this model when a(n) Country is deleted.

Syntax
OnDeleteCountry($hParams);
Input
$hParams (ref.hash.*)
primary key of object Country, key is
  • CountryID

UpdateEbayRegion

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

Syntax
UpdateEbayRegion($EbayRegionId, $hEbayRegion);
UpdateEbayRegion($hEbayRegion); # if $hEbayRegion includes EbayRegionId
Input
$EbayRegionId (int)
eBay's RegionId (primary key)
$hEbayRegion (reference to hash)
with following keys:
  • CountryID - country identifier - iso num code - int
  • Name - eBay's Region Name - nvarchar(255)