ePages 6.10 - DE_EPAGES/Customer/API/Table/CustomerUser.pm

Package DE_EPAGES::Customer::API::Table::CustomerUser

interface for table CustomerUser

@EXPORT_OK
InsertCustomerUser
DeleteCustomerUser
GetAllPKeyCustomerUsers
ExistsCustomerUser
GetPKeyCustomerUsersByUserID
GetInfoCustomerUsersByUserID
GetPKeyCustomerUsersByCustomerID
GetInfoCustomerUsersByCustomerID

Functions

DeleteCustomerUser
ExistsCustomerUser
GetAllPKeyCustomerUsers
GetInfoCustomerUsersByCustomerID
GetInfoCustomerUsersByUserID
GetPKeyCustomerUsersByCustomerID
GetPKeyCustomerUsersByUserID
InsertCustomerUser
OnDeleteUser

DeleteCustomerUser

Deletes a(n) CustomerUser.

Syntax
DeleteCustomerUser($UserID, $CustomerID);
DeleteCustomerUser($hCustomerUser); # if $hCustomerUser includes UserID, CustomerID
Input
$UserID (int)
user id (part of primary key)
$CustomerID (int)
customer identifier (part of primary key)

ExistsCustomerUser

Returns true if the CustomerUser exists.

Syntax
$exists = ExistsCustomerUser($UserID, $CustomerID);
Input
$UserID (int)
user id
$CustomerID (int)
customer identifier
Return
$exists (boolean)
1/0 the CustomerUser exists (yes/no)

GetAllPKeyCustomerUsers

Returns all CustomerUser identifiers.

Syntax
$ahCustomerUserIDs = GetAllPKeyCustomerUsers();
Return
$ahCustomerUserIDs (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • CustomerID - customer identifier - int

GetInfoCustomerUsersByCustomerID

Returns objects of CustomerUser by alternate key CustomerID.

Syntax
$ahCustomerUsers = GetInfoCustomerUsersByCustomerID($CustomerID);
Input
$CustomerID (int)
customer identifier
Return
$ahCustomerUsers (reference to array of hashes)
with following keys:
  • UserID - user id (part of primary key)- int
  • CustomerID - customer identifier (part of primary key)- int

GetInfoCustomerUsersByUserID

Returns objects of CustomerUser by primary key element UserID.

Syntax
$ahCustomerUsers = GetInfoCustomerUsersByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahCustomerUsers (reference to array of hashes)
with following keys:
  • UserID - user id (part of primary key)- int
  • CustomerID - customer identifier (part of primary key)- int

GetPKeyCustomerUsersByCustomerID

Returns primary keys of CustomerUser by alternate key CustomerID.

Syntax
$ahKeys = GetPKeyCustomerUsersByCustomerID($CustomerID);
Input
$CustomerID (int)
customer identifier
Return
$ahKeys (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • CustomerID - customer identifier - int

GetPKeyCustomerUsersByUserID

Returns primary keys of CustomerUser by primary key element UserID.

Syntax
$ahKeys = GetPKeyCustomerUsersByUserID($UserID);
Input
$UserID (int)
user id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • UserID - user id - int
  • CustomerID - customer identifier - int

InsertCustomerUser

Creates an entry of CustomerUser.

Syntax
InsertCustomerUser($hCustomerUser);
Input
$hCustomerUser (reference to hash)
with following keys:
  • UserID - user id (part of primary key)- int
  • CustomerID - customer identifier (part of primary key)- int

OnDeleteUser

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

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