ePages 6.10 - DE_EPAGES/Tax/API/Table/TaxAreaCountry.pm

Package DE_EPAGES::Tax::API::Table::TaxAreaCountry

interface for table TaxAreaCountry

@EXPORT_OK
InsertTaxAreaCountry
UpdateTaxAreaCountry
DeleteTaxAreaCountry
GetAllPKeyTaxAreaCountries
GetAllInfoTaxAreaCountries
GetInfoTaxAreaCountry
ExistsTaxAreaCountry
GetPKeyTaxAreaCountriesByTaxMatrixID
GetInfoTaxAreaCountriesByTaxMatrixID
GetPKeyTaxAreaCountriesByTaxAreaID
GetInfoTaxAreaCountriesByTaxAreaID

Functions

DeleteTaxAreaCountry
ExistsTaxAreaCountry
GetAllInfoTaxAreaCountries
GetAllPKeyTaxAreaCountries
GetInfoTaxAreaCountriesByTaxAreaID
GetInfoTaxAreaCountriesByTaxMatrixID
GetInfoTaxAreaCountry
GetPKeyTaxAreaCountriesByTaxAreaID
GetPKeyTaxAreaCountriesByTaxMatrixID
InsertTaxAreaCountry
OnDeleteCountry
UpdateTaxAreaCountry

DeleteTaxAreaCountry

Deletes a(n) TaxAreaCountry.

Syntax
DeleteTaxAreaCountry($TaxMatrixID, $CountryID);
DeleteTaxAreaCountry($hTaxAreaCountry); # if $hTaxAreaCountry includes TaxMatrixID, CountryID
Input
$TaxMatrixID (int)
tax matrix id (part of primary key)
$CountryID (int)
country id (part of primary key)

ExistsTaxAreaCountry

Returns true if the TaxAreaCountry exists.

Syntax
$exists = ExistsTaxAreaCountry($TaxMatrixID, $CountryID);
Input
$TaxMatrixID (int)
tax matrix id
$CountryID (int)
country id
Return
$exists (boolean)
1/0 the TaxAreaCountry exists (yes/no)

GetAllInfoTaxAreaCountries

Returns all objects of TaxAreaCountry.

Syntax
$ahTaxAreaCountrys = GetAllInfoTaxAreaCountries();
Return
$ahTaxAreaCountrys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id (part of primary key)- int
  • CountryID - country id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetAllPKeyTaxAreaCountries

Returns all TaxAreaCountry identifiers.

Syntax
$ahTaxAreaCountryIDs = GetAllPKeyTaxAreaCountries();
Return
$ahTaxAreaCountryIDs (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int

GetInfoTaxAreaCountriesByTaxAreaID

Returns objects of TaxAreaCountry by alternate key TaxAreaID.

Syntax
$ahTaxAreaCountries = GetInfoTaxAreaCountriesByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$ahTaxAreaCountries (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id (part of primary key)- int
  • CountryID - country id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetInfoTaxAreaCountriesByTaxMatrixID

Returns objects of TaxAreaCountry by primary key element TaxMatrixID.

Syntax
$ahTaxAreaCountries = GetInfoTaxAreaCountriesByTaxMatrixID($TaxMatrixID);
Input
$TaxMatrixID (int)
tax matrix id
Return
$ahTaxAreaCountries (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id (part of primary key)- int
  • CountryID - country id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetInfoTaxAreaCountry

Returns the TaxAreaCountry by identifier.

Syntax
$hTaxAreaCountry = GetInfoTaxAreaCountry($TaxMatrixID, $CountryID);
Input
$TaxMatrixID (int)
tax matrix id (part of primary key)
$CountryID (int)
country id (part of primary key)
Return
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxMatrixID - tax matrix id (part of primary key)- int
  • CountryID - country id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetPKeyTaxAreaCountriesByTaxAreaID

Returns primary keys of TaxAreaCountry by alternate key TaxAreaID.

Syntax
$ahKeys = GetPKeyTaxAreaCountriesByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int

GetPKeyTaxAreaCountriesByTaxMatrixID

Returns primary keys of TaxAreaCountry by primary key element TaxMatrixID.

Syntax
$ahKeys = GetPKeyTaxAreaCountriesByTaxMatrixID($TaxMatrixID);
Input
$TaxMatrixID (int)
tax matrix id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix id - int
  • CountryID - country id - int

InsertTaxAreaCountry

Creates an entry of TaxAreaCountry.

Syntax
InsertTaxAreaCountry($hTaxAreaCountry);
Input
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxMatrixID - tax matrix id (part of primary key)- int
  • CountryID - country id (part of primary key)- int
  • TaxAreaID - tax area id - int

OnDeleteCountry

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

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

UpdateTaxAreaCountry

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

Syntax
UpdateTaxAreaCountry($TaxMatrixID, $CountryID, $hTaxAreaCountry);
UpdateTaxAreaCountry($hTaxAreaCountry); # if $hTaxAreaCountry includes TaxMatrixID, CountryID
Input
$TaxMatrixID (int)
tax matrix id (part of primary key)
$CountryID (int)
country id (part of primary key)
$hTaxAreaCountry (reference to hash)
with following keys:
  • TaxAreaID - tax area id - int