ePages 7.1.0 - DE_EPAGES/RemoteSearch/API/DTO/Task.pm

Package DE_EPAGES::RemoteSearch::API::DTO::Task

Read only data object for a epages-j task. Only attributes 'link' and 'state' are mandatory options. Other attribtus may be omitted by the information provider.

Functions

completedAt
createdOn
error
link
startedAt
state

completedAt

When was this task completed. Returns ISO 8601 complient timestamp. Example: 2012-05-23T10:01:13.569Z

Syntax
my $FinishedSince  = $Task->completedAt();
Return
$FinishedSince (string or undef)
timestamp ISO 8601 complient

createdOn

When was this task added to epages-j job queue. Returns ISO 8601 complient timestamp. Example: 2012-05-23T10:01:13.569Z

Syntax
my $CreationTime  = $Task->createdOn();
Return
$CreationTime (string or undef)
timestamp ISO 8601 complient

error

Error description with complete stacktrace if $Task->state() eq 'Error'.

Syntax
my $ErrorDescription  = $Task->error();
Return
$ErrorDescription (string or undef)
error message

link

Link to original source of this task.

Syntax
my $TaskURL = $Task->link();
Return
$TaskURL (string)
url string

startedAt

When did epages-j start processing this task. Returns ISO 8601 complient timestamp. Example: 2012-05-23T10:01:13.569Z

Syntax
my $BeginProcessingTime  = $Task->startedAt();
Return
$BeginProcessingTime (string or undef)
timestamp ISO 8601 complient

state

Current status of this task. Possible Values: Pending, Error, Cancelled, Completed, Unscheduled, Delayed, Rejected
For detailed explaination check documentation of epages-j

Syntax
my $TaskStatus = $Task->state();
Return
$TaskStatus (string)
state