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

Package DE_EPAGES::Object::API::Table::MoneyAttribute

interface for table MoneyAttribute

@EXPORT_OK
InsertMoneyAttribute
UpdateMoneyAttribute
DeleteMoneyAttribute
GetAllPKeyMoneyAttributes
GetAllInfoMoneyAttributes
GetInfoMoneyAttribute
ExistsMoneyAttribute
GetPKeyMoneyAttributesByObjectID
GetInfoMoneyAttributesByObjectID
GetPKeyMoneyAttributesByAttributeID
GetInfoMoneyAttributesByAttributeID

Functions

DeleteMoneyAttribute
ExistsMoneyAttribute
GetAllInfoMoneyAttributes
GetAllPKeyMoneyAttributes
GetInfoMoneyAttribute
GetInfoMoneyAttributesByAttributeID
GetInfoMoneyAttributesByObjectID
GetPKeyMoneyAttributesByAttributeID
GetPKeyMoneyAttributesByObjectID
InsertMoneyAttribute
OnDeleteAttribute
OnDeleteObject
UpdateMoneyAttribute

DeleteMoneyAttribute

Deletes a(n) MoneyAttribute.

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

ExistsMoneyAttribute

Returns true if the MoneyAttribute exists.

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

GetAllInfoMoneyAttributes

Returns all objects of MoneyAttribute.

Syntax
$ahMoneyAttributes = GetAllInfoMoneyAttributes();
Return
$ahMoneyAttributes (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 - money value - money

GetAllPKeyMoneyAttributes

Returns all MoneyAttribute identifiers.

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

GetInfoMoneyAttribute

Returns the MoneyAttribute by identifier.

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

GetInfoMoneyAttributesByAttributeID

Returns objects of MoneyAttribute by alternate key AttributeID.

Syntax
$ahMoneyAttributes = GetInfoMoneyAttributesByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahMoneyAttributes (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 - money value - money

GetInfoMoneyAttributesByObjectID

Returns objects of MoneyAttribute by primary key element ObjectID.

Syntax
$ahMoneyAttributes = GetInfoMoneyAttributesByObjectID($ObjectID);
Input
$ObjectID (int)
object id
Return
$ahMoneyAttributes (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 - money value - money

GetPKeyMoneyAttributesByAttributeID

Returns primary keys of MoneyAttribute by alternate key AttributeID.

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

GetPKeyMoneyAttributesByObjectID

Returns primary keys of MoneyAttribute by primary key element ObjectID.

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

InsertMoneyAttribute

Creates an entry of MoneyAttribute.

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

OnDeleteAttribute

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

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

UpdateMoneyAttribute

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

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