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

Package DE_EPAGES::Object::API::Table::ReferenceLoop

interface for table ReferenceLoop

@EXPORT_OK
InsertReferenceLoop
UpdateReferenceLoop
DeleteReferenceLoop
GetAllPKeyReferenceLoops
GetAllInfoReferenceLoops
GetInfoReferenceLoop
ExistsReferenceLoop
GetPKeyReferenceLoopsByReferencedObjectID
GetInfoReferenceLoopsByReferencedObjectID
GetPKeyReferenceLoopsByAttributeID
GetInfoReferenceLoopsByAttributeID
GetPKeyReferenceLoopByObjectID
GetInfoReferenceLoopByObjectID
ExistsReferenceLoopByObjectID
GetPKeyReferenceLoopsByObjectID
GetInfoReferenceLoopsByObjectID

Functions

DeleteReferenceLoop
ExistsReferenceLoop
ExistsReferenceLoopByObjectID
GetAllInfoReferenceLoops
GetAllPKeyReferenceLoops
GetInfoReferenceLoop
GetInfoReferenceLoopByObjectID
GetInfoReferenceLoopsByAttributeID
GetInfoReferenceLoopsByObjectID
GetInfoReferenceLoopsByReferencedObjectID
GetPKeyReferenceLoopByObjectID
GetPKeyReferenceLoopsByAttributeID
GetPKeyReferenceLoopsByObjectID
GetPKeyReferenceLoopsByReferencedObjectID
InsertReferenceLoop
OnDeleteAttribute
UpdateReferenceLoop

DeleteReferenceLoop

Deletes a(n) ReferenceLoop.

Syntax
DeleteReferenceLoop($ReferenceLoopID);
DeleteReferenceLoop($hReferenceLoop); # if $hReferenceLoop includes ReferenceLoopID
Input
$ReferenceLoopID (int)
identifier of loop entry (primary key)

ExistsReferenceLoop

Returns true if the ReferenceLoop exists.

Syntax
$exists = ExistsReferenceLoop($ReferenceLoopID);
Input
$ReferenceLoopID (int)
identifier of loop entry
Return
$exists (boolean)
1/0 the ReferenceLoop exists (yes/no)

ExistsReferenceLoopByObjectID

Returns true if a ReferenceLoop by alternate keys ObjectID and AttributeID and Position exists.

Syntax
$ReferenceLoopID = ExistsReferenceLoopByObjectID($ObjectID, $AttributeID, $Position);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
$Position (int)
position loop
Return
$exists (boolean)
1/0 the u_object exists (yes/no)

GetAllInfoReferenceLoops

Returns all objects of ReferenceLoop.

Syntax
$ahReferenceLoops = GetAllInfoReferenceLoops();
Return
$ahReferenceLoops (reference to array of hashes)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetAllPKeyReferenceLoops

Returns all ReferenceLoop identifiers.

Syntax
$aReferenceLoopIDs = GetAllPKeyReferenceLoops();
Return
$aReferenceLoopIDs (reference to array of int)
identifier of loop entry

GetInfoReferenceLoop

Returns the ReferenceLoop by identifier.

Syntax
$hReferenceLoop = GetInfoReferenceLoop($ReferenceLoopID);
Input
$ReferenceLoopID (int)
identifier of loop entry (primary key)
Return
$hReferenceLoop (reference to hash)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetInfoReferenceLoopByObjectID

Returns the object of ReferenceLoop by alternate keys ObjectID and AttributeID and Position.

Syntax
$hReferenceLoop = GetInfoReferenceLoopByObjectID($ObjectID, $AttributeID, $Position);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
$Position (int)
position loop
Return
$hReferenceLoop (reference to hash)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetInfoReferenceLoopsByAttributeID

Returns objects of ReferenceLoop by alternate key AttributeID.

Syntax
$ahReferenceLoops = GetInfoReferenceLoopsByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$ahReferenceLoops (reference to array of hashes)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetInfoReferenceLoopsByObjectID

Returns objects of ReferenceLoop by alternate keys ObjectID and AttributeID and Position.

Syntax
$ahReferenceLoops = GetInfoReferenceLoopsByObjectID($ObjectID, $AttributeID, $Position);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id (optional)
$Position (int)
position loop (optional)
Return
$ahReferenceLoops (reference to array of hashes)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetInfoReferenceLoopsByReferencedObjectID

Returns objects of ReferenceLoop by alternate key ReferencedObjectID.

Syntax
$ahReferenceLoops = GetInfoReferenceLoopsByReferencedObjectID($ReferencedObjectID);
Input
$ReferencedObjectID (int)
object id
Return
$ahReferenceLoops (reference to array of hashes)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int

GetPKeyReferenceLoopByObjectID

Returns primary key of ReferenceLoop by alternate keys ObjectID and AttributeID and Position.

Syntax
$ReferenceLoopID = GetPKeyReferenceLoopByObjectID($ObjectID, $AttributeID, $Position);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id
$Position (int)
position loop
Return
$ReferenceLoopID (int)
identifier of loop entry (primary key)

GetPKeyReferenceLoopsByAttributeID

Returns primary keys of ReferenceLoop by alternate key AttributeID.

Syntax
$aKeys = GetPKeyReferenceLoopsByAttributeID($AttributeID);
Input
$AttributeID (int)
attribute id
Return
$aKeys (reference to array of int)
identifier of loop entry (primary key)

GetPKeyReferenceLoopsByObjectID

Returns primary keys of ReferenceLoop by alternate keys ObjectID and AttributeID and Position.

Syntax
$aKeys = GetPKeyReferenceLoopsByObjectID($ObjectID, $AttributeID, $Position);
Input
$ObjectID (int)
object id
$AttributeID (int)
attribute id (optional)
$Position (int)
position loop (optional)
Return
$aKeys (reference to array of int)
identifier of loop entry (primary key)

GetPKeyReferenceLoopsByReferencedObjectID

Returns primary keys of ReferenceLoop by alternate key ReferencedObjectID.

Syntax
$aKeys = GetPKeyReferenceLoopsByReferencedObjectID($ReferencedObjectID);
Input
$ReferencedObjectID (int)
object id
Return
$aKeys (reference to array of int)
identifier of loop entry (primary key)

InsertReferenceLoop

Creates an entry of ReferenceLoop.

Syntax
$ReferenceLoopID = InsertReferenceLoop($hReferenceLoop);
Input
$hReferenceLoop (reference to hash)
with following keys:
  • ReferenceLoopID - identifier of loop entry (primary key)(optional)- int
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int
Return
$ReferenceLoopID (int)
identifier of loop entry (primary key)

OnDeleteAttribute

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

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

UpdateReferenceLoop

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

Syntax
UpdateReferenceLoop($ReferenceLoopID, $hReferenceLoop);
UpdateReferenceLoop($hReferenceLoop); # if $hReferenceLoop includes ReferenceLoopID
Input
$ReferenceLoopID (int)
identifier of loop entry (primary key)
$hReferenceLoop (reference to hash)
with following keys:
  • ObjectID - object id - int
  • AttributeID - attribute id - int
  • Position - position loop - int
  • ReferencedObjectID - object id - int
Return
1 (int)
1