lumis.portal.processqueue

Interface IQueueTaskProcess

public interface IQueueTaskProcess

Interface that represents a queued process item.

Since:

6.1.0

Version:

$Revision: 14526 $ $Date: 2012-07-24 21:45:33 +0000 (Tue, 24 Jul 2012) $

Method Summary

Modifier and Type	Method and Description
Date	getEndDateTime() Returns the time the processed ended.
String	getId() Returns the id of the process in the queue.
Date	getQueuedDateTime() Returns the time the process was added to the queue.
Date	getScheduledDateTime() Returns the time the process is supposed to run.
Date	getStartDateTime() Returns the time the process started running.
QueueTaskProcessStatus	getStatus() Returns the status the process is in.
IQueueTask	getTask() Returns the process' task.
String	getTitle() Returns the title of the process.

Method Detail

getId

String getId()

Returns the id of the process in the queue.

Returns:

the id of the process in the queue.

Since:

6.1.0

getTitle

String getTitle()

Returns the title of the process.

Returns:

process's title.

Since:

6.1.0

getStatus

QueueTaskProcessStatus getStatus()

Returns the status the process is in.

Returns:

process's status.

Since:

6.1.0

getQueuedDateTime

Date getQueuedDateTime()

Returns the time the process was added to the queue.

Returns:

Date the process was put in queue.

Since:

6.1.0

getScheduledDateTime

Date getScheduledDateTime()

Returns the time the process is supposed to run.

Returns:

Date the process is scheduled to run.

Since:

6.1.0

getStartDateTime

Date getStartDateTime()

Returns the time the process started running.

Returns:

Date the process started to run.

Since:

6.1.0

getEndDateTime

Date getEndDateTime()

Returns the time the processed ended. Will only be available for a process in QueueTaskProcessStatus.Failed status.

Returns:

Date the process' run finish.

Since:

6.1.0

getTask

IQueueTask getTask()

Returns the process' task.

Returns:

the process' task.

Since:

6.1.0