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

Package DE_EPAGES::WebInterfacePoolDB::API::Table::Request

interface for table Request

@EXPORT_OK
InsertRequest
UpdateRequest
DeleteRequest
GetAllPKeyRequests
GetAllInfoRequests
GetInfoRequest
ExistsRequest
GetPKeyRequestByHostID
GetInfoRequestByHostID
ExistsRequestByHostID
GetPKeyRequestsByHostID
GetInfoRequestsByHostID
GetPKeyRequestsBySiteID
GetInfoRequestsBySiteID

Functions

DeleteRequest
ExistsRequest
ExistsRequestByHostID
GetAllInfoRequests
GetAllPKeyRequests
GetInfoRequest
GetInfoRequestByHostID
GetInfoRequestsByHostID
GetInfoRequestsBySiteID
GetPKeyRequestByHostID
GetPKeyRequestsByHostID
GetPKeyRequestsBySiteID
InsertRequest
UpdateRequest

DeleteRequest

Deletes a(n) Request.

Syntax
DeleteRequest($RequestID);
DeleteRequest($hRequest); # if $hRequest includes RequestID
Input
$RequestID (int)
request if (primary key)

ExistsRequest

Returns true if the Request exists.

Syntax
$exists = ExistsRequest($RequestID);
Input
$RequestID (int)
request if
Return
$exists (boolean)
1/0 the Request exists (yes/no)

ExistsRequestByHostID

Returns true if a Request by alternate keys HostID and URI exists.

Syntax
$RequestID = ExistsRequestByHostID($HostID, $URI);
Input
$HostID (int)
host id
$URI (text)
request URI prefix
Return
$exists (boolean)
1/0 the u_request exists (yes/no)

GetAllInfoRequests

Returns all objects of Request.

Syntax
$ahRequests = GetAllInfoRequests();
Return
$ahRequests (reference to array of hashes)
with following keys:
  • RequestID - request if (primary key)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text

GetAllPKeyRequests

Returns all Request identifiers.

Syntax
$aRequestIDs = GetAllPKeyRequests();
Return
$aRequestIDs (reference to array of int)
request if

GetInfoRequest

Returns the Request by identifier.

Syntax
$hRequest = GetInfoRequest($RequestID);
Input
$RequestID (int)
request if (primary key)
Return
$hRequest (reference to hash)
with following keys:
  • RequestID - request if (primary key)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text

GetInfoRequestByHostID

Returns the object of Request by alternate keys HostID and URI.

Syntax
$hRequest = GetInfoRequestByHostID($HostID, $URI);
Input
$HostID (int)
host id
$URI (text)
request URI prefix
Return
$hRequest (reference to hash)
with following keys:
  • RequestID - request if (primary key)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text

GetInfoRequestsByHostID

Returns objects of Request by alternate keys HostID and URI.

Syntax
$ahRequests = GetInfoRequestsByHostID($HostID, $URI);
Input
$HostID (int)
host id
$URI (text)
request URI prefix (optional)
Return
$ahRequests (reference to array of hashes)
with following keys:
  • RequestID - request if (primary key)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text

GetInfoRequestsBySiteID

Returns objects of Request by alternate key SiteID.

Syntax
$ahRequests = GetInfoRequestsBySiteID($SiteID);
Input
$SiteID (int)
site id
Return
$ahRequests (reference to array of hashes)
with following keys:
  • RequestID - request if (primary key)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text

GetPKeyRequestByHostID

Returns primary key of Request by alternate keys HostID and URI.

Syntax
$RequestID = GetPKeyRequestByHostID($HostID, $URI);
Input
$HostID (int)
host id
$URI (text)
request URI prefix
Return
$RequestID (int)
request if (primary key)

GetPKeyRequestsByHostID

Returns primary keys of Request by alternate keys HostID and URI.

Syntax
$aKeys = GetPKeyRequestsByHostID($HostID, $URI);
Input
$HostID (int)
host id
$URI (text)
request URI prefix (optional)
Return
$aKeys (reference to array of int)
request if (primary key)

GetPKeyRequestsBySiteID

Returns primary keys of Request by alternate key SiteID.

Syntax
$aKeys = GetPKeyRequestsBySiteID($SiteID);
Input
$SiteID (int)
site id
Return
$aKeys (reference to array of int)
request if (primary key)

InsertRequest

Creates an entry of Request.

Syntax
$RequestID = InsertRequest($hRequest);
Input
$hRequest (reference to hash)
with following keys:
  • RequestID - request if (primary key)(optional)- int
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text
Return
$RequestID (int)
request if (primary key)

UpdateRequest

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

Syntax
UpdateRequest($RequestID, $hRequest);
UpdateRequest($hRequest); # if $hRequest includes RequestID
Input
$RequestID (int)
request if (primary key)
$hRequest (reference to hash)
with following keys:
  • SiteID - site id - int
  • HostID - host id - int
  • URI - request URI prefix - text
Return
1 (int)
1