ePages 6.12.0 - DE_EPAGES/MeinPaket/API/Table/MeinPaketCategory.pm

Package DE_EPAGES::MeinPaket::API::Table::MeinPaketCategory

interface for table MeinPaketCategory

@EXPORT_OK
InsertMeinPaketCategory
UpdateMeinPaketCategory
DeleteMeinPaketCategory
GetAllPKeyMeinPaketCategories
GetAllInfoMeinPaketCategories
GetInfoMeinPaketCategory
ExistsMeinPaketCategory
GetPKeyMeinPaketCategoriesByMeinPaketSiteID
GetInfoMeinPaketCategoriesByMeinPaketSiteID
GetPKeyMeinPaketCategoriesByExternalCategoryID
GetInfoMeinPaketCategoriesByExternalCategoryID
GetPKeyMeinPaketCategoriesByParentCategoryID
GetInfoMeinPaketCategoriesByParentCategoryID
GetPKeyMeinPaketCategoriesByCategoryLevel
GetInfoMeinPaketCategoriesByCategoryLevel

Functions

DeleteMeinPaketCategory
ExistsMeinPaketCategory
GetAllInfoMeinPaketCategories
GetAllPKeyMeinPaketCategories
GetInfoMeinPaketCategoriesByCategoryLevel
GetInfoMeinPaketCategoriesByExternalCategoryID
GetInfoMeinPaketCategoriesByMeinPaketSiteID
GetInfoMeinPaketCategoriesByParentCategoryID
GetInfoMeinPaketCategory
GetPKeyMeinPaketCategoriesByCategoryLevel
GetPKeyMeinPaketCategoriesByExternalCategoryID
GetPKeyMeinPaketCategoriesByMeinPaketSiteID
GetPKeyMeinPaketCategoriesByParentCategoryID
InsertMeinPaketCategory
OnDeleteObject
UpdateMeinPaketCategory

DeleteMeinPaketCategory

Deletes a(n) MeinPaketCategory.

Syntax
DeleteMeinPaketCategory($MeinPaketCategoryID);
DeleteMeinPaketCategory($hMeinPaketCategory); # if $hMeinPaketCategory includes MeinPaketCategoryID
Input
$MeinPaketCategoryID (int)
object identifier (primary key)

ExistsMeinPaketCategory

Returns true if the MeinPaketCategory exists.

Syntax
$exists = ExistsMeinPaketCategory($MeinPaketCategoryID);
Input
$MeinPaketCategoryID (int)
object identifier
Return
$exists (boolean)
1/0 the MeinPaketCategory exists (yes/no)

GetAllInfoMeinPaketCategories

Returns all objects of MeinPaketCategory.

Syntax
$ahMeinPaketCategorys = GetAllInfoMeinPaketCategories();
Return
$ahMeinPaketCategorys (reference to array of hashes)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetAllPKeyMeinPaketCategories

Returns all MeinPaketCategory identifiers.

Syntax
$aMeinPaketCategoryIDs = GetAllPKeyMeinPaketCategories();
Return
$aMeinPaketCategoryIDs (reference to array of int)
object identifier

GetInfoMeinPaketCategoriesByCategoryLevel

Returns objects of MeinPaketCategory by alternate key CategoryLevel.

Syntax
$ahMeinPaketCategories = GetInfoMeinPaketCategoriesByCategoryLevel($CategoryLevel);
Input
$CategoryLevel (int)
category level. root level is 1, deeper levels ascending
Return
$ahMeinPaketCategories (reference to array of hashes)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetInfoMeinPaketCategoriesByExternalCategoryID

Returns objects of MeinPaketCategory by alternate key ExternalCategoryID.

Syntax
$ahMeinPaketCategories = GetInfoMeinPaketCategoriesByExternalCategoryID($ExternalCategoryID);
Input
$ExternalCategoryID (varchar(100))
meinpaket category identifier
Return
$ahMeinPaketCategories (reference to array of hashes)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetInfoMeinPaketCategoriesByMeinPaketSiteID

Returns objects of MeinPaketCategory by alternate key MeinPaketSiteID.

Syntax
$ahMeinPaketCategories = GetInfoMeinPaketCategoriesByMeinPaketSiteID($MeinPaketSiteID);
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier
Return
$ahMeinPaketCategories (reference to array of hashes)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetInfoMeinPaketCategoriesByParentCategoryID

Returns objects of MeinPaketCategory by alternate keys ParentCategoryID and MeinPaketSiteID.

Syntax
$ahMeinPaketCategories = GetInfoMeinPaketCategoriesByParentCategoryID($ParentCategoryID, $MeinPaketSiteID);
Input
$ParentCategoryID (varchar(100))
meinpaket parent category identifier
$MeinPaketSiteID (int)
MeinPaket Site identifier (optional)
Return
$ahMeinPaketCategories (reference to array of hashes)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetInfoMeinPaketCategory

Returns the MeinPaketCategory by identifier.

Syntax
$hMeinPaketCategory = GetInfoMeinPaketCategory($MeinPaketCategoryID);
Input
$MeinPaketCategoryID (int)
object identifier (primary key)
Return
$hMeinPaketCategory (reference to hash)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit

GetPKeyMeinPaketCategoriesByCategoryLevel

Returns primary keys of MeinPaketCategory by alternate key CategoryLevel.

Syntax
$aKeys = GetPKeyMeinPaketCategoriesByCategoryLevel($CategoryLevel);
Input
$CategoryLevel (int)
category level. root level is 1, deeper levels ascending
Return
$aKeys (reference to array of int)
object identifier (primary key)

GetPKeyMeinPaketCategoriesByExternalCategoryID

Returns primary keys of MeinPaketCategory by alternate key ExternalCategoryID.

Syntax
$aKeys = GetPKeyMeinPaketCategoriesByExternalCategoryID($ExternalCategoryID);
Input
$ExternalCategoryID (varchar(100))
meinpaket category identifier
Return
$aKeys (reference to array of int)
object identifier (primary key)

GetPKeyMeinPaketCategoriesByMeinPaketSiteID

Returns primary keys of MeinPaketCategory by alternate key MeinPaketSiteID.

Syntax
$aKeys = GetPKeyMeinPaketCategoriesByMeinPaketSiteID($MeinPaketSiteID);
Input
$MeinPaketSiteID (int)
MeinPaket Site identifier
Return
$aKeys (reference to array of int)
object identifier (primary key)

GetPKeyMeinPaketCategoriesByParentCategoryID

Returns primary keys of MeinPaketCategory by alternate keys ParentCategoryID and MeinPaketSiteID.

Syntax
$aKeys = GetPKeyMeinPaketCategoriesByParentCategoryID($ParentCategoryID, $MeinPaketSiteID);
Input
$ParentCategoryID (varchar(100))
meinpaket parent category identifier
$MeinPaketSiteID (int)
MeinPaket Site identifier (optional)
Return
$aKeys (reference to array of int)
object identifier (primary key)

InsertMeinPaketCategory

Creates an entry of MeinPaketCategory.

Syntax
$MeinPaketCategoryID = InsertMeinPaketCategory($hMeinPaketCategory);
Input
$hMeinPaketCategory (reference to hash)
with following keys:
  • MeinPaketCategoryID - object identifier (primary key)(optional)- int
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit
Return
$MeinPaketCategoryID (int)
object identifier (primary key)

OnDeleteObject

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

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

UpdateMeinPaketCategory

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

Syntax
UpdateMeinPaketCategory($MeinPaketCategoryID, $hMeinPaketCategory);
UpdateMeinPaketCategory($hMeinPaketCategory); # if $hMeinPaketCategory includes MeinPaketCategoryID
Input
$MeinPaketCategoryID (int)
object identifier (primary key)
$hMeinPaketCategory (reference to hash)
with following keys:
  • MeinPaketSiteID - MeinPaket Site identifier (optional)- int
  • ExternalCategoryID - meinpaket category identifier - varchar(100)
  • ParentCategoryID - meinpaket parent category identifier (optional)- varchar(100)
  • Name - meinpaket category name - varchar(100)
  • ShortDescription - category name (optional)- varchar(100)
  • CategoryLevel - category level. root level is 1, deeper levels ascending - int
  • IsLeaf - true, if this is a leaf category - bit