ePages 6.12.0 - DE_EPAGES/Presentation/API/Table/SessionTextParameter.pm

Package DE_EPAGES::Presentation::API::Table::SessionTextParameter

interface for table SessionTextParameter

@EXPORT_OK
InsertSessionTextParameter
UpdateSessionTextParameter
DeleteSessionTextParameter
GetAllPKeySessionTextParameters
GetAllInfoSessionTextParameters
GetInfoSessionTextParameter
ExistsSessionTextParameter
GetPKeySessionTextParametersByIntSessionID
GetInfoSessionTextParametersByIntSessionID
GetPKeySessionTextParametersBySessionAttributeID
GetInfoSessionTextParametersBySessionAttributeID

Functions

DeleteSessionTextParameter
ExistsSessionTextParameter
GetAllInfoSessionTextParameters
GetAllPKeySessionTextParameters
GetInfoSessionTextParameter
GetInfoSessionTextParametersByIntSessionID
GetInfoSessionTextParametersBySessionAttributeID
GetPKeySessionTextParametersByIntSessionID
GetPKeySessionTextParametersBySessionAttributeID
InsertSessionTextParameter
UpdateSessionTextParameter

DeleteSessionTextParameter

Deletes a(n) SessionTextParameter.

Syntax
DeleteSessionTextParameter($IntSessionID, $SessionAttributeID);
DeleteSessionTextParameter($hSessionTextParameter); # if $hSessionTextParameter includes IntSessionID, SessionAttributeID
Input
$IntSessionID (int)
internal (integer) session id (part of primary key)
$SessionAttributeID (int)
attribute identifier of session (part of primary key)

ExistsSessionTextParameter

Returns true if the SessionTextParameter exists.

Syntax
$exists = ExistsSessionTextParameter($IntSessionID, $SessionAttributeID);
Input
$IntSessionID (int)
internal (integer) session id
$SessionAttributeID (int)
attribute identifier of session
Return
$exists (boolean)
1/0 the SessionTextParameter exists (yes/no)

GetAllInfoSessionTextParameters

Returns all objects of SessionTextParameter.

Syntax
$ahSessionTextParameters = GetAllInfoSessionTextParameters();
Return
$ahSessionTextParameters (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id (part of primary key)- int
  • SessionAttributeID - attribute identifier of session (part of primary key)- int
  • Value - attribute value of session - text

GetAllPKeySessionTextParameters

Returns all SessionTextParameter identifiers.

Syntax
$ahSessionTextParameterIDs = GetAllPKeySessionTextParameters();
Return
$ahSessionTextParameterIDs (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id - int
  • SessionAttributeID - attribute identifier of session - int

GetInfoSessionTextParameter

Returns the SessionTextParameter by identifier.

Syntax
$hSessionTextParameter = GetInfoSessionTextParameter($IntSessionID, $SessionAttributeID);
Input
$IntSessionID (int)
internal (integer) session id (part of primary key)
$SessionAttributeID (int)
attribute identifier of session (part of primary key)
Return
$hSessionTextParameter (reference to hash)
with following keys:
  • IntSessionID - internal (integer) session id (part of primary key)- int
  • SessionAttributeID - attribute identifier of session (part of primary key)- int
  • Value - attribute value of session - text

GetInfoSessionTextParametersByIntSessionID

Returns objects of SessionTextParameter by primary key element IntSessionID.

Syntax
$ahSessionTextParameters = GetInfoSessionTextParametersByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal (integer) session id
Return
$ahSessionTextParameters (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id (part of primary key)- int
  • SessionAttributeID - attribute identifier of session (part of primary key)- int
  • Value - attribute value of session - text

GetInfoSessionTextParametersBySessionAttributeID

Returns objects of SessionTextParameter by alternate key SessionAttributeID.

Syntax
$ahSessionTextParameters = GetInfoSessionTextParametersBySessionAttributeID($SessionAttributeID);
Input
$SessionAttributeID (int)
attribute identifier of session
Return
$ahSessionTextParameters (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id (part of primary key)- int
  • SessionAttributeID - attribute identifier of session (part of primary key)- int
  • Value - attribute value of session - text

GetPKeySessionTextParametersByIntSessionID

Returns primary keys of SessionTextParameter by primary key element IntSessionID.

Syntax
$ahKeys = GetPKeySessionTextParametersByIntSessionID($IntSessionID);
Input
$IntSessionID (int)
internal (integer) session id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id - int
  • SessionAttributeID - attribute identifier of session - int

GetPKeySessionTextParametersBySessionAttributeID

Returns primary keys of SessionTextParameter by alternate key SessionAttributeID.

Syntax
$ahKeys = GetPKeySessionTextParametersBySessionAttributeID($SessionAttributeID);
Input
$SessionAttributeID (int)
attribute identifier of session
Return
$ahKeys (reference to array of hashes)
with following keys:
  • IntSessionID - internal (integer) session id - int
  • SessionAttributeID - attribute identifier of session - int

InsertSessionTextParameter

Creates an entry of SessionTextParameter.

Syntax
InsertSessionTextParameter($hSessionTextParameter);
Input
$hSessionTextParameter (reference to hash)
with following keys:
  • IntSessionID - internal (integer) session id (part of primary key)- int
  • SessionAttributeID - attribute identifier of session (part of primary key)- int
  • Value - attribute value of session - text

UpdateSessionTextParameter

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

Syntax
UpdateSessionTextParameter($IntSessionID, $SessionAttributeID, $hSessionTextParameter);
UpdateSessionTextParameter($hSessionTextParameter); # if $hSessionTextParameter includes IntSessionID, SessionAttributeID
Input
$IntSessionID (int)
internal (integer) session id (part of primary key)
$SessionAttributeID (int)
attribute identifier of session (part of primary key)
$hSessionTextParameter (reference to hash)
with following keys:
  • Value - attribute value of session - text