ePages 6.10 - DE_EPAGES/Presentation/API/Table/PageTypeHelpTopic.pm

Package DE_EPAGES::Presentation::API::Table::PageTypeHelpTopic

interface for table PageTypeHelpTopic

@EXPORT_OK
InsertPageTypeHelpTopic
UpdatePageTypeHelpTopic
DeletePageTypeHelpTopic
GetAllPKeyPageTypeHelpTopics
GetAllInfoPageTypeHelpTopics
GetInfoPageTypeHelpTopic
ExistsPageTypeHelpTopic
GetPKeyPageTypeHelpTopicsByPageTypeID
GetInfoPageTypeHelpTopicsByPageTypeID
GetPKeyPageTypeHelpTopicsByHelpTopicID
GetInfoPageTypeHelpTopicsByHelpTopicID

Functions

DeletePageTypeHelpTopic
ExistsPageTypeHelpTopic
GetAllInfoPageTypeHelpTopics
GetAllPKeyPageTypeHelpTopics
GetInfoPageTypeHelpTopic
GetInfoPageTypeHelpTopicsByHelpTopicID
GetInfoPageTypeHelpTopicsByPageTypeID
GetPKeyPageTypeHelpTopicsByHelpTopicID
GetPKeyPageTypeHelpTopicsByPageTypeID
InsertPageTypeHelpTopic
OnDeletePageType
UpdatePageTypeHelpTopic

DeletePageTypeHelpTopic

Deletes a(n) PageTypeHelpTopic.

Syntax
DeletePageTypeHelpTopic($PageTypeID, $HelpTopicID);
DeletePageTypeHelpTopic($hPageTypeHelpTopic); # if $hPageTypeHelpTopic includes PageTypeID, HelpTopicID
Input
$PageTypeID (int)
tray group id (part of primary key)
$HelpTopicID (int)
tray group id (part of primary key)

ExistsPageTypeHelpTopic

Returns true if the PageTypeHelpTopic exists.

Syntax
$exists = ExistsPageTypeHelpTopic($PageTypeID, $HelpTopicID);
Input
$PageTypeID (int)
tray group id
$HelpTopicID (int)
tray group id
Return
$exists (boolean)
1/0 the PageTypeHelpTopic exists (yes/no)

GetAllInfoPageTypeHelpTopics

Returns all objects of PageTypeHelpTopic.

Syntax
$ahPageTypeHelpTopics = GetAllInfoPageTypeHelpTopics();
Return
$ahPageTypeHelpTopics (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id (part of primary key)- int
  • HelpTopicID - tray group id (part of primary key)- int
  • Position - position - int

GetAllPKeyPageTypeHelpTopics

Returns all PageTypeHelpTopic identifiers.

Syntax
$ahPageTypeHelpTopicIDs = GetAllPKeyPageTypeHelpTopics();
Return
$ahPageTypeHelpTopicIDs (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id - int
  • HelpTopicID - tray group id - int

GetInfoPageTypeHelpTopic

Returns the PageTypeHelpTopic by identifier.

Syntax
$hPageTypeHelpTopic = GetInfoPageTypeHelpTopic($PageTypeID, $HelpTopicID);
Input
$PageTypeID (int)
tray group id (part of primary key)
$HelpTopicID (int)
tray group id (part of primary key)
Return
$hPageTypeHelpTopic (reference to hash)
with following keys:
  • PageTypeID - tray group id (part of primary key)- int
  • HelpTopicID - tray group id (part of primary key)- int
  • Position - position - int

GetInfoPageTypeHelpTopicsByHelpTopicID

Returns objects of PageTypeHelpTopic by alternate key HelpTopicID.

Syntax
$ahPageTypeHelpTopics = GetInfoPageTypeHelpTopicsByHelpTopicID($HelpTopicID);
Input
$HelpTopicID (int)
tray group id
Return
$ahPageTypeHelpTopics (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id (part of primary key)- int
  • HelpTopicID - tray group id (part of primary key)- int
  • Position - position - int

GetInfoPageTypeHelpTopicsByPageTypeID

Returns objects of PageTypeHelpTopic by primary key element PageTypeID.

Syntax
$ahPageTypeHelpTopics = GetInfoPageTypeHelpTopicsByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
tray group id
Return
$ahPageTypeHelpTopics (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id (part of primary key)- int
  • HelpTopicID - tray group id (part of primary key)- int
  • Position - position - int

GetPKeyPageTypeHelpTopicsByHelpTopicID

Returns primary keys of PageTypeHelpTopic by alternate key HelpTopicID.

Syntax
$ahKeys = GetPKeyPageTypeHelpTopicsByHelpTopicID($HelpTopicID);
Input
$HelpTopicID (int)
tray group id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id - int
  • HelpTopicID - tray group id - int

GetPKeyPageTypeHelpTopicsByPageTypeID

Returns primary keys of PageTypeHelpTopic by primary key element PageTypeID.

Syntax
$ahKeys = GetPKeyPageTypeHelpTopicsByPageTypeID($PageTypeID);
Input
$PageTypeID (int)
tray group id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • PageTypeID - tray group id - int
  • HelpTopicID - tray group id - int

InsertPageTypeHelpTopic

Creates an entry of PageTypeHelpTopic.

Syntax
InsertPageTypeHelpTopic($hPageTypeHelpTopic);
Input
$hPageTypeHelpTopic (reference to hash)
with following keys:
  • PageTypeID - tray group id (part of primary key)- int
  • HelpTopicID - tray group id (part of primary key)- int
  • Position - position - int

OnDeletePageType

Deletes PageTypeHelpTopic of this model when a(n) PageType is deleted.

Syntax
OnDeletePageType($hParams);
Input
$hParams (ref.hash.*)
primary key of object PageType, key is
  • PageTypeID

UpdatePageTypeHelpTopic

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

Syntax
UpdatePageTypeHelpTopic($PageTypeID, $HelpTopicID, $hPageTypeHelpTopic);
UpdatePageTypeHelpTopic($hPageTypeHelpTopic); # if $hPageTypeHelpTopic includes PageTypeID, HelpTopicID
Input
$PageTypeID (int)
tray group id (part of primary key)
$HelpTopicID (int)
tray group id (part of primary key)
$hPageTypeHelpTopic (reference to hash)
with following keys:
  • Position - position - int