ePages 7.0.0 - DE_EPAGES/Object/API/Object/LastUpdateProfile.pm

Package DE_EPAGES::Object::API::Object::LastUpdateProfile

object interface for LastUpdateProfile.

Base
DE_EPAGES::Object::API::Object::Object

Functions

className
clearLastUpdates
dbPackage
findLastUpdates
getLastUpdate
getLastUpdates
setLastUpdate

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $LastUpdateProfile->className;
Return
$ClassName (String)
class name

clearLastUpdates

Deletes information about updated objects in the site of a given profile.

Syntax
$Object->clearLastUpdates( $Site, $UpdatedBefore );
Input
$Site (object)
site object
$UpdatedBefore (DateTime)
date and time

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $LastUpdateProfile->dbPackage;
Return
$DbPackage (String)
database package name

findLastUpdates

Returns information about updated objects after a given date realated to this profile,

Syntax
$Iterator = $Object->findLastUpdates( $Site, $UpdatedAfter );
Input
$Site (object)
site object
$UpdatedAfter (DateTime)
date and time
Return
$Iterator (Iterator of hashes)
iterator over hash references with following keys:
  • ObjectID - object id - int
  • LastUpdatedOn - Date and time of the deletion on an object - datetime

getLastUpdate

get last update timestamp for object related to this profile if never touched return undef

Syntax
$Timestamp = $Profile->getLastUpdate( $Object );
Example
print $StockLevelProfile->getLastUpdate( $Product );
Input
$Object (object)
object updated sometimes before
Return
$LastUpdatedOn (DateTime)
time stamp when the product updated last time

getLastUpdates

Returns updated objects after a given date realated to this profile,

Syntax
$Iterator = $Object->getLastUpdates( $Site, $UpdatedAfter );
Input
$Site (object)
site object
$UpdatedAfter (DateTime)
date and time
Return
$Iterator (Iterator of hashes)
iterator over hash references with following keys:
  • Object - object - object
  • LastUpdatedOn - Date and time of the deletion on an object - datetime

setLastUpdate

set last update timestamp now for object related to this profile

Syntax
$Profile->setLastUpdate( $UpdatedObject );
Example
$StockLevelProfile->setLastUpdate( $Product );
Input
$UpdatedObject (object)
updated object