ePages 6.0 Patch 4 - DE_EPAGES/Tax/API/Table/TaxAreaUser.pm

Package DE_EPAGES::Tax::API::Table::TaxAreaUser

interface for table TaxAreaUser

@EXPORT_OK
InsertTaxAreaUser
UpdateTaxAreaUser
DeleteTaxAreaUser
GetAllPKeyTaxAreaUsers
GetAllInfoTaxAreaUsers
GetInfoTaxAreaUser
ExistsTaxAreaUser
GetPKeyTaxAreaUsersByTaxMatrixID
GetInfoTaxAreaUsersByTaxMatrixID
GetPKeyTaxAreaUsersByUserID
GetInfoTaxAreaUsersByUserID
GetPKeyTaxAreaUsersByTaxAreaID
GetInfoTaxAreaUsersByTaxAreaID

Functions

DeleteTaxAreaUser
ExistsTaxAreaUser
GetAllInfoTaxAreaUsers
GetAllPKeyTaxAreaUsers
GetInfoTaxAreaUser
GetInfoTaxAreaUsersByTaxAreaID
GetInfoTaxAreaUsersByTaxMatrixID
GetInfoTaxAreaUsersByUserID
GetPKeyTaxAreaUsersByTaxAreaID
GetPKeyTaxAreaUsersByTaxMatrixID
GetPKeyTaxAreaUsersByUserID
InsertTaxAreaUser
OnDeleteUser
UpdateTaxAreaUser

DeleteTaxAreaUser

Deletes a(n) TaxAreaUser.

Syntax
DeleteTaxAreaUser($TaxMatrixID, $UserID);
DeleteTaxAreaUser($hTaxAreaUser); # if $hTaxAreaUser includes TaxMatrixID, UserID
Input
$TaxMatrixID (int)
tax matrix object id (part of primary key)
$UserID (int)
user id (part of primary key)

ExistsTaxAreaUser

Returns true if the TaxAreaUser exists.

Syntax
$exists = ExistsTaxAreaUser($TaxMatrixID, $UserID);
Input
$TaxMatrixID (int)
tax matrix object id
$UserID (int)
user id
Return
$exists (boolean)
1/0 the TaxAreaUser exists (yes/no)

GetAllInfoTaxAreaUsers

Returns all objects of TaxAreaUser.

Syntax
$ahTaxAreaUserIDs = GetAllInfoTaxAreaUsers();
Return
$ahTaxAreaUserIDs (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetAllPKeyTaxAreaUsers

Returns all TaxAreaUser identifiers.

Syntax
$ahTaxAreaUserIDs = GetAllPKeyTaxAreaUsers();
Return
$ahTaxAreaUserIDs (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id - int
  • UserID - user id - int

GetInfoTaxAreaUser

Returns the TaxAreaUser by identifier.

Syntax
$hTaxAreaUser = GetInfoTaxAreaUser($TaxMatrixID, $UserID);
Input
$TaxMatrixID (int)
tax matrix object id (part of primary key)
$UserID (int)
user id (part of primary key)
Return
$hTaxAreaUser (reference to hash)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetInfoTaxAreaUsersByTaxAreaID

Returns objects of TaxAreaUser by alternate key TaxAreaID.

Syntax
$ahTaxAreaUsers = GetInfoTaxAreaUsersByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$ahTaxAreaUsers (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetInfoTaxAreaUsersByTaxMatrixID

Returns objects of TaxAreaUser by primary key element TaxMatrixID.

Syntax
$ahTaxAreaUsers = GetInfoTaxAreaUsersByTaxMatrixID($TaxMatrixID);
Input
$TaxMatrixID (int)
tax matrix object id
Return
$ahTaxAreaUsers (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetInfoTaxAreaUsersByUserID

Returns objects of TaxAreaUser by alternate key UserID.

Syntax
$ahTaxAreaUsers = GetInfoTaxAreaUsersByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahTaxAreaUsers (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

GetPKeyTaxAreaUsersByTaxAreaID

Returns primary keys of TaxAreaUser by alternate key TaxAreaID.

Syntax
$ahKeys = GetPKeyTaxAreaUsersByTaxAreaID($TaxAreaID);
Input
$TaxAreaID (int)
tax area id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id - int
  • UserID - user id - int

GetPKeyTaxAreaUsersByTaxMatrixID

Returns primary keys of TaxAreaUser by primary key element TaxMatrixID.

Syntax
$ahKeys = GetPKeyTaxAreaUsersByTaxMatrixID($TaxMatrixID);
Input
$TaxMatrixID (int)
tax matrix object id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id - int
  • UserID - user id - int

GetPKeyTaxAreaUsersByUserID

Returns primary keys of TaxAreaUser by alternate key UserID.

Syntax
$ahKeys = GetPKeyTaxAreaUsersByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TaxMatrixID - tax matrix object id - int
  • UserID - user id - int

InsertTaxAreaUser

Creates an entry of TaxAreaUser.

Syntax
InsertTaxAreaUser($hTaxAreaUser);
Input
$hTaxAreaUser (reference to hash)
with following keys:
  • TaxMatrixID - tax matrix object id (part of primary key)- int
  • UserID - user id (part of primary key)- int
  • TaxAreaID - tax area id - int

OnDeleteUser

Deletes TaxAreaUser of this model when a(n) User is deleted.

Syntax
OnDeleteUser($hParams);
Input
$hParams (ref.hash.*)
primary key of object User, key is
  • UserID

UpdateTaxAreaUser

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

Syntax
UpdateTaxAreaUser($TaxMatrixID, $UserID, $hTaxAreaUser);
UpdateTaxAreaUser($hTaxAreaUser); # if $hTaxAreaUser includes TaxMatrixID, UserID
Input
$TaxMatrixID (int)
tax matrix object id (part of primary key)
$UserID (int)
user id (part of primary key)
$hTaxAreaUser (reference to hash)
with following keys:
  • TaxAreaID - tax area id - int