ePages 6.11.0 - DE_EPAGES/Object/API/Table/BooleanAttribute.pm

Package DE_EPAGES::Object::API::Table::BooleanAttribute

interface for table BooleanAttribute

@EXPORT_OK
InsertBooleanAttribute
UpdateBooleanAttribute
DeleteBooleanAttribute
GetAllPKeyBooleanAttributes
GetAllInfoBooleanAttributes
GetInfoBooleanAttribute
ExistsBooleanAttribute
GetPKeyBooleanAttributesByObjectID
GetInfoBooleanAttributesByObjectID
GetPKeyBooleanAttributesByAttributeID
GetInfoBooleanAttributesByAttributeID

Functions

DeleteBooleanAttribute
ExistsBooleanAttribute
GetAllInfoBooleanAttributes
GetAllPKeyBooleanAttributes
GetInfoBooleanAttribute
GetInfoBooleanAttributesByAttributeID
GetInfoBooleanAttributesByObjectID
GetPKeyBooleanAttributesByAttributeID
GetPKeyBooleanAttributesByObjectID
InsertBooleanAttribute
OnDeleteAttribute
OnDeleteObject
UpdateBooleanAttribute

DeleteBooleanAttribute

Deletes a(n) BooleanAttribute.

Syntax
DeleteBooleanAttribute($ObjectID, $AttributeID);
DeleteBooleanAttribute($hBooleanAttribute); # if $hBooleanAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)

ExistsBooleanAttribute

Returns true if the BooleanAttribute exists.

Syntax
$exists = ExistsBooleanAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
Return
$exists (boolean)
1/0 the BooleanAttribute exists (yes/no)

GetAllInfoBooleanAttributes

Returns all objects of BooleanAttribute.

Syntax
$ahBooleanAttributes = GetAllInfoBooleanAttributes();
Return
$ahBooleanAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - boolean value - tinyint

GetAllPKeyBooleanAttributes

Returns all BooleanAttribute identifiers.

Syntax
$ahBooleanAttributeIDs = GetAllPKeyBooleanAttributes();
Return
$ahBooleanAttributeIDs (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int

GetInfoBooleanAttribute

Returns the BooleanAttribute by identifier.

Syntax
$hBooleanAttribute = GetInfoBooleanAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
Return
$hBooleanAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - boolean value - tinyint

GetInfoBooleanAttributesByAttributeID

Returns objects of BooleanAttribute by alternate key AttributeID.

Syntax
$ahBooleanAttributes = GetInfoBooleanAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahBooleanAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - boolean value - tinyint

GetInfoBooleanAttributesByObjectID

Returns objects of BooleanAttribute by primary key element ObjectID.

Syntax
$ahBooleanAttributes = GetInfoBooleanAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahBooleanAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - boolean value - tinyint

GetPKeyBooleanAttributesByAttributeID

Returns primary keys of BooleanAttribute by alternate key AttributeID.

Syntax
$ahKeys = GetPKeyBooleanAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int

GetPKeyBooleanAttributesByObjectID

Returns primary keys of BooleanAttribute by primary key element ObjectID.

Syntax
$ahKeys = GetPKeyBooleanAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahKeys (reference to array of hashes)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int

InsertBooleanAttribute

Creates an entry of BooleanAttribute.

Syntax
InsertBooleanAttribute($hBooleanAttribute);
Input
$hBooleanAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - boolean value - tinyint

OnDeleteAttribute

Deletes BooleanAttribute of this model when a(n) Attribute is deleted.

Syntax
OnDeleteAttribute($hParams);
Input
$hParams (ref.hash.*)
primary key of object Attribute, key is
  • AttributeID

OnDeleteObject

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

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

UpdateBooleanAttribute

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

Syntax
UpdateBooleanAttribute($ObjectID, $AttributeID, $hBooleanAttribute);
UpdateBooleanAttribute($hBooleanAttribute); # if $hBooleanAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$hBooleanAttribute (reference to hash)
with following keys:
  • Value - boolean value - tinyint