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

Package DE_EPAGES::Object::API::Table::ReferenceAttribute

interface for table ReferenceAttribute

@EXPORT_OK
InsertReferenceAttribute
UpdateReferenceAttribute
DeleteReferenceAttribute
GetAllPKeyReferenceAttributes
GetAllInfoReferenceAttributes
GetInfoReferenceAttribute
ExistsReferenceAttribute
GetPKeyReferenceAttributesByObjectID
GetInfoReferenceAttributesByObjectID
GetPKeyReferenceAttributesByReferencedObjectID
GetInfoReferenceAttributesByReferencedObjectID
GetPKeyReferenceAttributesByAttributeID
GetInfoReferenceAttributesByAttributeID

Functions

DeleteReferenceAttribute
ExistsReferenceAttribute
GetAllInfoReferenceAttributes
GetAllPKeyReferenceAttributes
GetInfoReferenceAttribute
GetInfoReferenceAttributesByAttributeID
GetInfoReferenceAttributesByObjectID
GetInfoReferenceAttributesByReferencedObjectID
GetPKeyReferenceAttributesByAttributeID
GetPKeyReferenceAttributesByObjectID
GetPKeyReferenceAttributesByReferencedObjectID
InsertReferenceAttribute
OnDeleteAttribute
UpdateReferenceAttribute

DeleteReferenceAttribute

Deletes a(n) ReferenceAttribute.

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

ExistsReferenceAttribute

Returns true if the ReferenceAttribute exists.

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

GetAllInfoReferenceAttributes

Returns all objects of ReferenceAttribute.

Syntax
$ahReferenceAttributes = GetAllInfoReferenceAttributes();
Return
$ahReferenceAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

GetAllPKeyReferenceAttributes

Returns all ReferenceAttribute identifiers.

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

GetInfoReferenceAttribute

Returns the ReferenceAttribute by identifier.

Syntax
$hReferenceAttribute = GetInfoReferenceAttribute($ObjectID, $AttributeID);
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
Return
$hReferenceAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

GetInfoReferenceAttributesByAttributeID

Returns objects of ReferenceAttribute by alternate key AttributeID.

Syntax
$ahReferenceAttributes = GetInfoReferenceAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahReferenceAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

GetInfoReferenceAttributesByObjectID

Returns objects of ReferenceAttribute by primary key element ObjectID.

Syntax
$ahReferenceAttributes = GetInfoReferenceAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahReferenceAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

GetInfoReferenceAttributesByReferencedObjectID

Returns objects of ReferenceAttribute by alternate key ReferencedObjectID.

Syntax
$ahReferenceAttributes = GetInfoReferenceAttributesByReferencedObjectID($ReferencedObjectID);
Input
$ReferencedObjectID (int)
object id
Return
$ahReferenceAttributes (reference to array of hashes)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

GetPKeyReferenceAttributesByAttributeID

Returns primary keys of ReferenceAttribute by alternate key AttributeID.

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

GetPKeyReferenceAttributesByObjectID

Returns primary keys of ReferenceAttribute by primary key element ObjectID.

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

GetPKeyReferenceAttributesByReferencedObjectID

Returns primary keys of ReferenceAttribute by alternate key ReferencedObjectID.

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

InsertReferenceAttribute

Creates an entry of ReferenceAttribute.

Syntax
InsertReferenceAttribute($hReferenceAttribute);
Input
$hReferenceAttribute (reference to hash)
with following keys:
  • ObjectID - object id (part of primary key)- int
  • AttributeID - attribute id (part of primary key)- int
  • ReferencedObjectID - object id - int

OnDeleteAttribute

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

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

UpdateReferenceAttribute

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

Syntax
UpdateReferenceAttribute($ObjectID, $AttributeID, $hReferenceAttribute);
UpdateReferenceAttribute($hReferenceAttribute); # if $hReferenceAttribute includes ObjectID, AttributeID
Input
$ObjectID (int)
object id (part of primary key)
$AttributeID (int)
attribute id (part of primary key)
$hReferenceAttribute (reference to hash)
with following keys:
  • ReferencedObjectID - object id - int