lumis.portal.processqueue
Class QueueTaskProcess

java.lang.Object
  lumis.portal.processqueue.QueueTaskProcess

All Implemented Interfaces:

IQueueTaskProcess

public class QueueTaskProcess
extends Object
implements IQueueTaskProcess

Represents a queued process item.

Since:

6.1.0

Field Summary

static String	NAMED_QUERY_FIND_LAST_SCHEDULED_TIME_FOR_GROUP Finds the last queued process of a group and returns it.
static String	NAMED_QUERY_FIND_NEXT_SCHEDULED_ITEM Searches for the next task processor in Scheduled status.

Constructor Summary

QueueTaskProcess()
Default constructor

Method Summary

Date	getEndDateTime() Returns the time the processed ended.
String	getGroupId() Returns the group defined for the process.
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.
void	setEndDateTime(Date endtime) Sets the time the processed ended.
void	setGroup(String groupId) Sets the group defined for the process.
void	setId(String id) Sets the id of the process in the queue.
void	setQueuedDateTime(Date queued) Sets the time the process was added to the queue.
void	setScheduledDateTime(Date scheduled) Sets the time the process is supposed to run.
void	setStartDateTime(Date start) Sets the time the process started running.
void	setStatus(QueueTaskProcessStatus status) Sets the status the process is in.
void	setTask(IQueueTask task) Returns the process' task.
void	setTitle(String title) Sets the title of the process.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAMED_QUERY_FIND_NEXT_SCHEDULED_ITEM

public static final String NAMED_QUERY_FIND_NEXT_SCHEDULED_ITEM

Searches for the next task processor in Scheduled status.

See Also:

Constant Field Values

NAMED_QUERY_FIND_LAST_SCHEDULED_TIME_FOR_GROUP

public static final String NAMED_QUERY_FIND_LAST_SCHEDULED_TIME_FOR_GROUP

Finds the last queued process of a group and returns it. Parameter: groupId

See Also:

Constant Field Values

Constructor Detail

QueueTaskProcess

public QueueTaskProcess()

Default constructor

Since:

6.1.0

Method Detail

getId

public String getId()

Returns the id of the process in the queue.

Specified by:

getId in interface IQueueTaskProcess

Returns:

the id of the process in the queue.

Since:

6.1.0

getTitle

public String getTitle()

Returns the title of the process.

Specified by:

getTitle in interface IQueueTaskProcess

Returns:

process's title.

Since:

6.1.0

getStatus

public QueueTaskProcessStatus getStatus()

Returns the status the process is in.

Specified by:

getStatus in interface IQueueTaskProcess

Returns:

process's status.

Since:

6.1.0

getGroupId

public String getGroupId()

Returns the group defined for the process. Returns null if no group was defined for the process.

Specified by:

getGroupId in interface IQueueTaskProcess

Returns:

the process' group.

Since:

6.1.0

getQueuedDateTime

public Date getQueuedDateTime()

Returns the time the process was added to the queue.

Specified by:

getQueuedDateTime in interface IQueueTaskProcess

Returns:

Date the process was put in queue.

Since:

6.1.0

getScheduledDateTime

public Date getScheduledDateTime()

Returns the time the process is supposed to run.

Specified by:

getScheduledDateTime in interface IQueueTaskProcess

Returns:

Date the process is scheduled to run.

Since:

6.1.0

getStartDateTime

public Date getStartDateTime()

Returns the time the process started running.

Specified by:

getStartDateTime in interface IQueueTaskProcess

Returns:

Date the process started to run.

Since:

6.1.0

getEndDateTime

public Date getEndDateTime()

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

Specified by:

getEndDateTime in interface IQueueTaskProcess

Returns:

Date the process' run finish.

Since:

6.1.0

getTask

public IQueueTask getTask()

Returns the process' task.

Specified by:

getTask in interface IQueueTaskProcess

Returns:

the process' task.

Since:

6.1.0

setId

public void setId(String id)

Sets the id of the process in the queue.

Parameters:

id - of the process in the queue.

Since:

6.1.0

setTitle

public void setTitle(String title)

Sets the title of the process.

Parameters:

title - of the process.

Since:

6.1.0

setStatus

public void setStatus(QueueTaskProcessStatus status)

Sets the status the process is in.

Parameters:

status - of the process.

Since:

6.1.0

setGroup

public void setGroup(String groupId)

Sets the group defined for the process. A group will guarantee ordered processing for it's group members.

Parameters:

groupId - of the process.

Since:

6.1.0

setQueuedDateTime

public void setQueuedDateTime(Date queued)

Sets the time the process was added to the queue.

Parameters:

queued - the date/time the process was put in queue.

Since:

6.1.0

setScheduledDateTime

public void setScheduledDateTime(Date scheduled)

Sets the time the process is supposed to run.

Parameters:

scheduled - the date/time the process is/was scheduled to run.

Since:

6.1.0

setStartDateTime

public void setStartDateTime(Date start)

Sets the time the process started running.

Parameters:

start - the date/time the process started to run.

Since:

6.1.0

setEndDateTime

public void setEndDateTime(Date endtime)

Sets the time the processed ended.

Parameters:

endtime - the date/time the process finished.

Since:

6.1.0

setTask

public void setTask(IQueueTask task)

Returns the process' task.

Parameters:

task - the process' task.

Since:

6.1.0