ePages 7.21.0 - DE_EPAGES/Object/API/Table/ObjectDelete.pm

Package DE_EPAGES::Object::API::Table::ObjectDelete

interface for table ObjectDelete

@EXPORT_OK
InsertObjectDelete
UpdateObjectDelete
DeleteObjectDelete
GetAllPKeyObjectDeletes
GetAllInfoObjectDeletes
GetInfoObjectDelete
ExistsObjectDelete
GetPKeyObjectDeletesBySiteID
GetInfoObjectDeletesBySiteID
GetPKeyObjectDeletesByClassID
GetInfoObjectDeletesByClassID

Functions

DeleteObjectDelete
ExistsObjectDelete
GetAllInfoObjectDeletes
GetAllPKeyObjectDeletes
GetInfoObjectDelete
GetInfoObjectDeletesByClassID
GetInfoObjectDeletesBySiteID
GetPKeyObjectDeletesByClassID
GetPKeyObjectDeletesBySiteID
InsertObjectDelete
OnDeleteClass
OnDeleteSite
UpdateObjectDelete

DeleteObjectDelete

Deletes a(n) ObjectDelete.

Syntax
DeleteObjectDelete($GUID);
DeleteObjectDelete($hObjectDelete); # if $hObjectDelete includes GUID
Input
$GUID (varchar(36))
GUID of the deleted object (primary key)

ExistsObjectDelete

Returns true if the ObjectDelete exists.

Syntax
$exists = ExistsObjectDelete($GUID);
Input
$GUID (varchar(36))
GUID of the deleted object (primary key)
Return
$exists (boolean)
1/0 the ObjectDelete exists (yes/no)

GetAllInfoObjectDeletes

Returns all objects of ObjectDelete.

Syntax
$ahObjectDeletes = GetAllInfoObjectDeletes();
Return
$ahObjectDeletes (reference to array of hashes)
with following keys:
  • GUID - GUID of the deleted object (primary key)- varchar(36)
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime

GetAllPKeyObjectDeletes

Returns all ObjectDelete identifiers.

Syntax
$aObjectDeleteIDs = GetAllPKeyObjectDeletes();
Return
$aObjectDeleteIDs (reference to array of varchar(36))
GUID of the deleted object

GetInfoObjectDelete

Returns the ObjectDelete by identifier.

Syntax
$hObjectDelete = GetInfoObjectDelete($GUID);
Input
$GUID (varchar(36))
GUID of the deleted object (primary key)
Return
$hObjectDelete (reference to hash)
with following keys:
  • GUID - GUID of the deleted object (primary key)- varchar(36)
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime

GetInfoObjectDeletesByClassID

Returns objects of ObjectDelete by alternate key ClassID.

Syntax
$ahObjectDeletes = GetInfoObjectDeletesByClassID($ClassID);
Input
$ClassID (int)
Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket".
Return
$ahObjectDeletes (reference to array of hashes)
with following keys:
  • GUID - GUID of the deleted object (primary key)- varchar(36)
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime

GetInfoObjectDeletesBySiteID

Returns objects of ObjectDelete by alternate keys SiteID and ClassID and DeletedOn.

Syntax
$ahObjectDeletes = GetInfoObjectDeletesBySiteID($SiteID, $ClassID, $DeletedOn);
Input
$SiteID (int)
Site ID
$ClassID (int)
Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". (optional)
$DeletedOn (datetime)
Date and time of the deletion on an object (optional)
Return
$ahObjectDeletes (reference to array of hashes)
with following keys:
  • GUID - GUID of the deleted object (primary key)- varchar(36)
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime

GetPKeyObjectDeletesByClassID

Returns primary keys of ObjectDelete by alternate key ClassID.

Syntax
$aKeys = GetPKeyObjectDeletesByClassID($ClassID);
Input
$ClassID (int)
Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket".
Return
$aKeys (reference to array of varchar(36))
GUID of the deleted object (primary key)

GetPKeyObjectDeletesBySiteID

Returns primary keys of ObjectDelete by alternate keys SiteID and ClassID and DeletedOn.

Syntax
$aKeys = GetPKeyObjectDeletesBySiteID($SiteID, $ClassID, $DeletedOn);
Input
$SiteID (int)
Site ID
$ClassID (int)
Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". (optional)
$DeletedOn (datetime)
Date and time of the deletion on an object (optional)
Return
$aKeys (reference to array of varchar(36))
GUID of the deleted object (primary key)

InsertObjectDelete

Creates an entry of ObjectDelete.

Syntax
InsertObjectDelete($hObjectDelete);
Input
$hObjectDelete (reference to hash)
with following keys:
  • GUID - GUID of the deleted object (primary key)- varchar(36)
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime

OnDeleteClass

Deletes ObjectDelete of this model when a(n) Class is deleted.

Syntax
OnDeleteClass($hParams);
Input
$hParams (ref.hash.*)
primary key of object Class, key is
  • ClassID

OnDeleteSite

Deletes ObjectDelete of this model when a(n) Site is deleted.

Syntax
OnDeleteSite($hParams);
Input
$hParams (ref.hash.*)
primary key of object Site, key is
  • SiteID

UpdateObjectDelete

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

Syntax
UpdateObjectDelete($GUID, $hObjectDelete);
UpdateObjectDelete($hObjectDelete); # if $hObjectDelete includes GUID
Input
$GUID (varchar(36))
GUID of the deleted object (primary key)
$hObjectDelete (reference to hash)
with following keys:
  • SiteID - Site ID - int
  • ClassID - Class ID. This should be a generic class like "Product" rather than a sub class like "Jacket". - int
  • PathFromSite - Object Path relative to the object site. - varchar(1000)
  • DeletedOn - Date and time of the deletion on an object - datetime