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

Package DE_EPAGES::Object::API::Table::StringAttribute

interface for table StringAttribute

@EXPORT_OK
InsertStringAttribute
UpdateStringAttribute
DeleteStringAttribute
GetAllPKeyStringAttributes
GetAllInfoStringAttributes
GetInfoStringAttribute
ExistsStringAttribute
GetPKeyStringAttributesByObjectID
GetInfoStringAttributesByObjectID
GetPKeyStringAttributesByAttributeID
GetInfoStringAttributesByAttributeID

Functions

DeleteStringAttribute
ExistsStringAttribute
GetAllInfoStringAttributes
GetAllPKeyStringAttributes
GetInfoStringAttribute
GetInfoStringAttributesByAttributeID
GetInfoStringAttributesByObjectID
GetPKeyStringAttributesByAttributeID
GetPKeyStringAttributesByObjectID
InsertStringAttribute
OnDeleteAttribute
OnDeleteObject
UpdateStringAttribute

DeleteStringAttribute

Deletes a(n) StringAttribute.

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

ExistsStringAttribute

Returns true if the StringAttribute exists.

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

GetAllInfoStringAttributes

Returns all objects of StringAttribute.

Syntax
$ahStringAttributes = GetAllInfoStringAttributes();
Return
$ahStringAttributes (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 - string value <256 characters - nvarchar(255)

GetAllPKeyStringAttributes

Returns all StringAttribute identifiers.

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

GetInfoStringAttribute

Returns the StringAttribute by identifier.

Syntax
$hStringAttribute = GetInfoStringAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
Return
$hStringAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - string value <256 characters - nvarchar(255)

GetInfoStringAttributesByAttributeID

Returns objects of StringAttribute by alternate key AttributeID.

Syntax
$ahStringAttributes = GetInfoStringAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahStringAttributes (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 - string value <256 characters - nvarchar(255)

GetInfoStringAttributesByObjectID

Returns objects of StringAttribute by primary key element ObjectID.

Syntax
$ahStringAttributes = GetInfoStringAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahStringAttributes (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 - string value <256 characters - nvarchar(255)

GetPKeyStringAttributesByAttributeID

Returns primary keys of StringAttribute by alternate key AttributeID.

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

GetPKeyStringAttributesByObjectID

Returns primary keys of StringAttribute by primary key element ObjectID.

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

InsertStringAttribute

Creates an entry of StringAttribute.

Syntax
InsertStringAttribute($hStringAttribute);
Input
$hStringAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • Value - string value <256 characters - nvarchar(255)

OnDeleteAttribute

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

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

UpdateStringAttribute

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

Syntax
UpdateStringAttribute($ObjectID, $AttributeID, $hStringAttribute);
UpdateStringAttribute($hStringAttribute); # if $hStringAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$hStringAttribute (reference to hash)
with following keys:
  • Value - string value <256 characters - nvarchar(255)