ePages 6.11.0 - DE_EPAGES/WebInterfacePoolDB/API/Table/PoolExtension.pm

Package DE_EPAGES::WebInterfacePoolDB::API::Table::PoolExtension

interface for table PoolExtension

@EXPORT_OK
InsertPoolExtension
UpdatePoolExtension
DeletePoolExtension
GetAllPKeyPoolExtensions
GetAllInfoPoolExtensions
GetInfoPoolExtension
ExistsPoolExtension
GetPKeyPoolExtensionsByPoolID
GetInfoPoolExtensionsByPoolID

Functions

DeletePoolExtension
ExistsPoolExtension
GetAllInfoPoolExtensions
GetAllPKeyPoolExtensions
GetInfoPoolExtension
GetInfoPoolExtensionsByPoolID
GetPKeyPoolExtensionsByPoolID
InsertPoolExtension
UpdatePoolExtension

DeletePoolExtension

Deletes a(n) PoolExtension.

Syntax
DeletePoolExtension($PoolID, $Extension);
DeletePoolExtension($hPoolExtension); # if $hPoolExtension includes PoolID, Extension
Input
$PoolID (int)
pool id (part of primary key)
$Extension (varchar(15))
URL script extension (part of primary key)

ExistsPoolExtension

Returns true if the PoolExtension exists.

Syntax
$exists = ExistsPoolExtension($PoolID, $Extension);
Input
$PoolID (int)
pool id
$Extension (varchar(15))
URL script extension
Return
$exists (boolean)
1/0 the PoolExtension exists (yes/no)

GetAllInfoPoolExtensions

Returns all objects of PoolExtension.

Syntax
$ahPoolExtensions = GetAllInfoPoolExtensions();
Return
$ahPoolExtensions (reference to array of hashes)
with following keys:
  • PoolID - pool id (part of primary key)- int
  • Extension - URL script extension (part of primary key)- varchar(15)
  • MaxServers - maximum number of parallel processes - int

GetAllPKeyPoolExtensions

Returns all PoolExtension identifiers.

Syntax
$ahPoolExtensionIDs = GetAllPKeyPoolExtensions();
Return
$ahPoolExtensionIDs (reference to array of hashes)
with following keys:
  • PoolID - pool id - int
  • Extension - URL script extension - varchar(15)

GetInfoPoolExtension

Returns the PoolExtension by identifier.

Syntax
$hPoolExtension = GetInfoPoolExtension($PoolID, $Extension);
Input
$PoolID (int)
pool id (part of primary key)
$Extension (varchar(15))
URL script extension (part of primary key)
Return
$hPoolExtension (reference to hash)
with following keys:
  • PoolID - pool id (part of primary key)- int
  • Extension - URL script extension (part of primary key)- varchar(15)
  • MaxServers - maximum number of parallel processes - int

GetInfoPoolExtensionsByPoolID

Returns objects of PoolExtension by primary key element PoolID.

Syntax
$ahPoolExtensions = GetInfoPoolExtensionsByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$ahPoolExtensions (reference to array of hashes)
with following keys:
  • PoolID - pool id (part of primary key)- int
  • Extension - URL script extension (part of primary key)- varchar(15)
  • MaxServers - maximum number of parallel processes - int

GetPKeyPoolExtensionsByPoolID

Returns primary keys of PoolExtension by primary key element PoolID.

Syntax
$ahKeys = GetPKeyPoolExtensionsByPoolID($PoolID);
Input
$PoolID (int)
pool id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • PoolID - pool id - int
  • Extension - URL script extension - varchar(15)

InsertPoolExtension

Creates an entry of PoolExtension.

Syntax
InsertPoolExtension($hPoolExtension);
Input
$hPoolExtension (reference to hash)
with following keys:
  • PoolID - pool id (part of primary key)(optional)- int
  • Extension - URL script extension (part of primary key)- varchar(15)
  • MaxServers - maximum number of parallel processes - int

UpdatePoolExtension

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

Syntax
UpdatePoolExtension($PoolID, $Extension, $hPoolExtension);
UpdatePoolExtension($hPoolExtension); # if $hPoolExtension includes PoolID, Extension
Input
$PoolID (int)
pool id (part of primary key)
$Extension (varchar(15))
URL script extension (part of primary key)
$hPoolExtension (reference to hash)
with following keys:
  • MaxServers - maximum number of parallel processes - int
Return
1 (int)
1