lumis.portal.processqueue
Interface IQueueTaskProcess

Package class diagram package IQueueTaskProcess
All Known Implementing Classes:
QueueTaskProcess

public interface IQueueTaskProcess

Interface that represents a queued process item.

Since:
6.1.0

Method Summary
 java.util.Date getEndDateTime()
          Returns the time the processed ended.
 java.lang.String getGroupId()
          Returns the group defined for the process.
 java.lang.String getId()
          Returns the id of the process in the queue.
 java.util.Date getQueuedDateTime()
          Returns the time the process was added to the queue.
 java.util.Date getScheduledDateTime()
          Returns the time the process is supposed to run.
 java.util.Date getStartDateTime()
          Returns the time the process started running.
 QueueTaskProcessStatus getStatus()
          Returns the status the process is in.
 IQueueTask getTask()
          Returns the process' task.
 java.lang.String getTitle()
          Returns the title of the process.
 

Method Detail

getId

java.lang.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

java.lang.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

getGroupId

java.lang.String getGroupId()
Returns the group defined for the process. Returns null if no group was defined for the process.

Returns:
the process' group.
Since:
6.1.0

getQueuedDateTime

java.util.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

java.util.Date getScheduledDateTime()
Returns the time the process is supposed to run.

Returns:
Date the process is scheduled to run.
Since:
6.1.0

getStartDateTime

java.util.Date getStartDateTime()
Returns the time the process started running.

Returns:
Date the process started to run.
Since:
6.1.0

getEndDateTime

java.util.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


Lumisportal  6.1.0.111014 - Copyright © 2001-2007, Lumis. All Rights Reserved.