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

Package DE_EPAGES::Presentation::API::Table::TrayGroup

interface for table TrayGroup

@EXPORT_OK
InsertTrayGroup
UpdateTrayGroup
DeleteTrayGroup
GetAllPKeyTrayGroups
GetAllInfoTrayGroups
GetInfoTrayGroup
ExistsTrayGroup
GetPKeyTrayGroupsByIntSessionID
GetInfoTrayGroupsByIntSessionID

Functions

DeleteTrayGroup
ExistsTrayGroup
GetAllInfoTrayGroups
GetAllPKeyTrayGroups
GetInfoTrayGroup
GetInfoTrayGroupsByIntSessionID
GetPKeyTrayGroupsByIntSessionID
InsertTrayGroup
OnDeleteObject
OnDeleteSession
UpdateTrayGroup

DeleteTrayGroup

Deletes a(n) TrayGroup.

Syntax
DeleteTrayGroup($TrayGroupID);
DeleteTrayGroup($hTrayGroup); # if $hTrayGroup includes TrayGroupID
Input
$TrayGroupID (int)
tray group id (primary key)

ExistsTrayGroup

Returns true if the TrayGroup exists.

Syntax
$exists = ExistsTrayGroup($TrayGroupID);
Input
$TrayGroupID (int)
tray group id
Return
$exists (boolean)
1/0 the TrayGroup exists (yes/no)

GetAllInfoTrayGroups

Returns all objects of TrayGroup.

Syntax
$ahTrayGroups = GetAllInfoTrayGroups();
Return
$ahTrayGroups (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id (primary key)- int
  • IntSessionID - internal session id - int
  • Position - position of group - int
  • Name - name of group - nvarchar(255)
  • CountElements - count of objects in group - int

GetAllPKeyTrayGroups

Returns all TrayGroup identifiers.

Syntax
$aTrayGroupIDs = GetAllPKeyTrayGroups();
Return
$aTrayGroupIDs (reference to array of int)
tray group id

GetInfoTrayGroup

Returns the TrayGroup by identifier.

Syntax
$hTrayGroup = GetInfoTrayGroup($TrayGroupID);
Input
$TrayGroupID (int)
tray group id (primary key)
Return
$hTrayGroup (reference to hash)
with following keys:
  • TrayGroupID - tray group id (primary key)- int
  • IntSessionID - internal session id - int
  • Position - position of group - int
  • Name - name of group - nvarchar(255)
  • CountElements - count of objects in group - int

GetInfoTrayGroupsByIntSessionID

Returns objects of TrayGroup by alternate key IntSessionID.

Syntax
$ahTrayGroups = GetInfoTrayGroupsByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal session id
Return
$ahTrayGroups (reference to array of hashes)
with following keys:
  • TrayGroupID - tray group id (primary key)- int
  • IntSessionID - internal session id - int
  • Position - position of group - int
  • Name - name of group - nvarchar(255)
  • CountElements - count of objects in group - int

GetPKeyTrayGroupsByIntSessionID

Returns primary keys of TrayGroup by alternate key IntSessionID.

Syntax
$aKeys = GetPKeyTrayGroupsByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal session id
Return
$aKeys (reference to array of int)
tray group id (primary key)

InsertTrayGroup

Creates an entry of TrayGroup.

Syntax
$TrayGroupID = InsertTrayGroup($hTrayGroup);
Input
$hTrayGroup (reference to hash)
with following keys:
  • TrayGroupID - tray group id (primary key)(optional)- int
  • IntSessionID - internal session id - int
  • Position - position of group - int
  • Name - name of group - nvarchar(255)
  • CountElements - count of objects in group - int
Return
$TrayGroupID (int)
tray group id (primary key)

OnDeleteObject

Deletes TrayElement when a Object is deleted, delete TrayGroup if its empty after remove with object.

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

OnDeleteSession

Deletes TrayGroup of this model when a(n) Session is deleted.

Syntax
OnDeleteSession($hParams);
Input
$hParams (ref.hash.*)
primary key of object Session, key is
  • IntSessionID

UpdateTrayGroup

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

Syntax
UpdateTrayGroup($TrayGroupID, $hTrayGroup);
UpdateTrayGroup($hTrayGroup); # if $hTrayGroup includes TrayGroupID
Input
$TrayGroupID (int)
tray group id (primary key)
$hTrayGroup (reference to hash)
with following keys:
  • IntSessionID - internal session id - int
  • Position - position of group - int
  • Name - name of group - nvarchar(255)
  • CountElements - count of objects in group - int
Return
1 (int)
1