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

Package DE_EPAGES::Presentation::API::Table::EventHistory

interface for table EventHistory

@EXPORT_OK
InsertEventHistory
UpdateEventHistory
DeleteEventHistory
GetAllPKeyEventHistories
GetAllInfoEventHistories
GetInfoEventHistory
ExistsEventHistory
GetPKeyEventHistoriesByIntSessionID
GetInfoEventHistoriesByIntSessionID
GetPKeyEventHistoriesByObjectID
GetInfoEventHistoriesByObjectID

Functions

DeleteEventHistory
ExistsEventHistory
GetAllInfoEventHistories
GetAllPKeyEventHistories
GetInfoEventHistoriesByIntSessionID
GetInfoEventHistoriesByObjectID
GetInfoEventHistory
GetPKeyEventHistoriesByIntSessionID
GetPKeyEventHistoriesByObjectID
InsertEventHistory
OnDeleteObject
OnDeleteSession
UpdateEventHistory

DeleteEventHistory

Deletes a(n) EventHistory.

Syntax
DeleteEventHistory($EventHistoryID);
DeleteEventHistory($hEventHistory); # if $hEventHistory includes EventHistoryID
Input
$EventHistoryID (int)
view anchor indentifier (primary key)

ExistsEventHistory

Returns true if the EventHistory exists.

Syntax
$exists = ExistsEventHistory($EventHistoryID);
Input
$EventHistoryID (int)
view anchor indentifier
Return
$exists (boolean)
1/0 the EventHistory exists (yes/no)

GetAllInfoEventHistories

Returns all objects of EventHistory.

Syntax
$ahEventHistorys = GetAllInfoEventHistories();
Return
$ahEventHistorys (reference to array of hashes)
with following keys:
  • EventHistoryID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetAllPKeyEventHistories

Returns all EventHistory identifiers.

Syntax
$aEventHistoryIDs = GetAllPKeyEventHistories();
Return
$aEventHistoryIDs (reference to array of int)
view anchor indentifier

GetInfoEventHistoriesByIntSessionID

Returns objects of EventHistory by alternate key IntSessionID.

Syntax
$ahEventHistories = GetInfoEventHistoriesByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal session id
Return
$ahEventHistories (reference to array of hashes)
with following keys:
  • EventHistoryID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetInfoEventHistoriesByObjectID

Returns objects of EventHistory by alternate key ObjectID.

Syntax
$ahEventHistories = GetInfoEventHistoriesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahEventHistories (reference to array of hashes)
with following keys:
  • EventHistoryID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetInfoEventHistory

Returns the EventHistory by identifier.

Syntax
$hEventHistory = GetInfoEventHistory($EventHistoryID);
Input
$EventHistoryID (int)
view anchor indentifier (primary key)
Return
$hEventHistory (reference to hash)
with following keys:
  • EventHistoryID - view anchor indentifier (primary key)- int
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)

GetPKeyEventHistoriesByIntSessionID

Returns primary keys of EventHistory by alternate key IntSessionID.

Syntax
$aKeys = GetPKeyEventHistoriesByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal session id
Return
$aKeys (reference to array of int)
view anchor indentifier (primary key)

GetPKeyEventHistoriesByObjectID

Returns primary keys of EventHistory by alternate key ObjectID.

Syntax
$aKeys = GetPKeyEventHistoriesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$aKeys (reference to array of int)
view anchor indentifier (primary key)

InsertEventHistory

Creates an entry of EventHistory.

Syntax
$EventHistoryID = InsertEventHistory($hEventHistory);
Input
$hEventHistory (reference to hash)
with following keys:
  • EventHistoryID - view anchor indentifier (primary key)(optional)- int
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)
Return
$EventHistoryID (int)
view anchor indentifier (primary key)

OnDeleteObject

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

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

OnDeleteSession

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

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

UpdateEventHistory

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

Syntax
UpdateEventHistory($EventHistoryID, $hEventHistory);
UpdateEventHistory($hEventHistory); # if $hEventHistory includes EventHistoryID
Input
$EventHistoryID (int)
view anchor indentifier (primary key)
$hEventHistory (reference to hash)
with following keys:
  • ObjectID - object id (optional)- int
  • IntSessionID - internal session id - int
  • Name - title or name of page - nvarchar(255)
  • URI - Uniform Resource Identifiers of get request - varchar(500)