ePages 6.11.0 - DE_EPAGES/Presentation/API/Table/TrayElement.pm

Package DE_EPAGES::Presentation::API::Table::TrayElement

interface for table TrayElement

@EXPORT_OK
InsertTrayElement
DeleteTrayElement
GetAllPKeyTrayElements
ExistsTrayElement
GetPKeyTrayElementsByTrayGroupID
GetInfoTrayElementsByTrayGroupID
GetPKeyTrayElementsByObjectID
GetInfoTrayElementsByObjectID

Functions

DeleteTrayElement
ExistsTrayElement
GetAllPKeyTrayElements
GetInfoTrayElementsByObjectID
GetInfoTrayElementsByTrayGroupID
GetPKeyTrayElementsByObjectID
GetPKeyTrayElementsByTrayGroupID
InsertTrayElement
OnDeleteObject

DeleteTrayElement

Deletes a(n) TrayElement.

Syntax
DeleteTrayElement($TrayGroupID, $ObjectID);
DeleteTrayElement($hTrayElement); # if $hTrayElement includes TrayGroupID, ObjectID
Input
$TrayGroupID (int)
tray group id (part of primary key)
$ObjectID (int)
object id (part of primary key)

ExistsTrayElement

Returns true if the TrayElement exists.

Syntax
$exists = ExistsTrayElement($TrayGroupID, $ObjectID);
Input
$TrayGroupID (int)
tray group id
$ObjectID (int)
object id
Return
$exists (boolean)
1/0 the TrayElement exists (yes/no)

GetAllPKeyTrayElements

Returns all TrayElement identifiers.

Syntax
$ahTrayElementIDs = GetAllPKeyTrayElements();
Return
$ahTrayElementIDs (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id - int
  • ObjectID - object id - int

GetInfoTrayElementsByObjectID

Returns objects of TrayElement by alternate key ObjectID.

Syntax
$ahTrayElements = GetInfoTrayElementsByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahTrayElements (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id (part of primary key)- int
  • ObjectID - object id (part of primary key)- int

GetInfoTrayElementsByTrayGroupID

Returns objects of TrayElement by primary key element TrayGroupID.

Syntax
$ahTrayElements = GetInfoTrayElementsByTrayGroupID($TrayGroupID);
Input
$TrayGroupID (int)
tray group id
Return
$ahTrayElements (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id (part of primary key)- int
  • ObjectID - object id (part of primary key)- int

GetPKeyTrayElementsByObjectID

Returns primary keys of TrayElement by alternate key ObjectID.

Syntax
$ahKeys = GetPKeyTrayElementsByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id - int
  • ObjectID - object id - int

GetPKeyTrayElementsByTrayGroupID

Returns primary keys of TrayElement by primary key element TrayGroupID.

Syntax
$ahKeys = GetPKeyTrayElementsByTrayGroupID($TrayGroupID);
Input
$TrayGroupID (int)
tray group id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id - int
  • ObjectID - object id - int

InsertTrayElement

Creates an entry of TrayElement.

Syntax
InsertTrayElement($hTrayElement);
Input
$hTrayElement (reference to hash)
with following keys:
  • TrayGroupID - tray group id (part of primary key)- int
  • ObjectID - object id (part of primary key)- int

OnDeleteObject

Deletes TrayElement of this model when a(n) Object is deleted.

Syntax
OnDeleteObject($hParams);
Input
$hParams (ref.hash.*)
primary key of object Object, key is
  • ObjectID