ePages 6.10 - DE_EPAGES/Object/API/Table/IntegerAttribute.pm

Package DE_EPAGES::Object::API::Table::IntegerAttribute

interface for table IntegerAttribute

@EXPORT_OK
InsertIntegerAttribute
UpdateIntegerAttribute
DeleteIntegerAttribute
GetAllPKeyIntegerAttributes
GetAllInfoIntegerAttributes
GetInfoIntegerAttribute
ExistsIntegerAttribute
GetPKeyIntegerAttributesByObjectID
GetInfoIntegerAttributesByObjectID
GetPKeyIntegerAttributesByAttributeID
GetInfoIntegerAttributesByAttributeID

Functions

DeleteIntegerAttribute
ExistsIntegerAttribute
GetAllInfoIntegerAttributes
GetAllPKeyIntegerAttributes
GetInfoIntegerAttribute
GetInfoIntegerAttributesByAttributeID
GetInfoIntegerAttributesByObjectID
GetPKeyIntegerAttributesByAttributeID
GetPKeyIntegerAttributesByObjectID
InsertIntegerAttribute
OnDeleteAttribute
OnDeleteObject
UpdateIntegerAttribute

DeleteIntegerAttribute

Deletes a(n) IntegerAttribute.

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

ExistsIntegerAttribute

Returns true if the IntegerAttribute exists.

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

GetAllInfoIntegerAttributes

Returns all objects of IntegerAttribute.

Syntax
$ahIntegerAttributes = GetAllInfoIntegerAttributes();
Return
$ahIntegerAttributes (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 - integer value - int

GetAllPKeyIntegerAttributes

Returns all IntegerAttribute identifiers.

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

GetInfoIntegerAttribute

Returns the IntegerAttribute by identifier.

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

GetInfoIntegerAttributesByAttributeID

Returns objects of IntegerAttribute by alternate key AttributeID.

Syntax
$ahIntegerAttributes = GetInfoIntegerAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahIntegerAttributes (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 - integer value - int

GetInfoIntegerAttributesByObjectID

Returns objects of IntegerAttribute by primary key element ObjectID.

Syntax
$ahIntegerAttributes = GetInfoIntegerAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahIntegerAttributes (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 - integer value - int

GetPKeyIntegerAttributesByAttributeID

Returns primary keys of IntegerAttribute by alternate key AttributeID.

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

GetPKeyIntegerAttributesByObjectID

Returns primary keys of IntegerAttribute by primary key element ObjectID.

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

InsertIntegerAttribute

Creates an entry of IntegerAttribute.

Syntax
InsertIntegerAttribute($hIntegerAttribute);
Input
$hIntegerAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - integer value - int

OnDeleteAttribute

Deletes IntegerAttribute 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 IntegerAttribute of this model when a(n) Object is deleted.

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

UpdateIntegerAttribute

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

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