lumis.portal.processqueue
Interface IProcessQueueManager

All Known Subinterfaces:

IProcessQueueManagerSPI

All Known Implementing Classes:

QueueManager

public interface IProcessQueueManager

Manager that allows a process to be executed asynchronously as well as see what is currently queued.

Since:

6.1.0

Method Summary

IQueueStatistics	getQueueStatistics() Retrieves the current situation statistics of the queue.
IQueueTaskProcess	getTaskProcess(String processId) Retrieves the queue item of represented by the processId.
void	reprocess(String processId) Triggers the process to be retried.
String	schedule(IQueueTask task, Date schedule) Schedules an IQueueTask to be executed at a specific time.
String	schedule(IQueueTask task, Date schedule, String group, String title) Schedules an IQueueTask to be executed at a specific time, in the specified group, with the informed title.
String	send(IQueueTask task) Sends a IQueueTask to be executed.
String	send(IQueueTask task, String groupId) Sends a IQueueTask to be executed in within the order of a group.
String	send(IQueueTask task, String groupId, String title) Sends an IQueueTask to the queue for a specific group with the given title.
String	send(String title, IQueueTask task) Sends an IQueueTask to the queue with the given title.

Method Detail

send

String send(IQueueTask task)
            throws PortalException

Sends a IQueueTask to be executed.

Parameters:

task - to be executed.

Returns:

id of the process.

Throws:

PortalException

Since:

6.1.0

send

String send(IQueueTask task,
            String groupId)
            throws PortalException

Sends a IQueueTask to be executed in within the order of a group.

Parameters:

task - to be executed.

groupId - of the group the task should respect the order.

Returns:

id of the process.

Throws:

PortalException

Since:

6.1.0

schedule

String schedule(IQueueTask task,
                Date schedule)
                throws PortalException

Schedules an IQueueTask to be executed at a specific time.

Parameters:

task - to be executed.

schedule - date/time the task is to be executed.

Returns:

id of the process.

Throws:

PortalException

Since:

6.1.0

schedule

String schedule(IQueueTask task,
                Date schedule,
                String group,
                String title)
                throws PortalException

Schedules an IQueueTask to be executed at a specific time, in the specified group, with the informed title.

Parameters:

task - to be executed.

schedule - date/time the task is to be executed.

group - group in which the task should be executed.

title - of the task to help identify it in the queue.

Throws:

PortalException

Since:

6.1.0

getTaskProcess

IQueueTaskProcess getTaskProcess(String processId)
                                 throws PortalException

Retrieves the queue item of represented by the processId.

Parameters:

processId -

Returns:

the queue item

Throws:

PortalException

Since:

6.1.0

send

String send(String title,
            IQueueTask task)
            throws PortalException

Sends an IQueueTask to the queue with the given title.

Parameters:

title - to help identify the process in the queue.

task - to be executed.

Returns:

id of the process.

Throws:

PortalException

Since:

6.1.0

send

String send(IQueueTask task,
            String groupId,
            String title)
            throws PortalException

Sends an IQueueTask to the queue for a specific group with the given title.

Parameters:

task - to be executed.

groupId - group in which the task should be executed.

title - of the task to help identify it in the queue.

Returns:

id of the process.

Throws:

PortalException

Since:

6.1.0

getQueueStatistics

IQueueStatistics getQueueStatistics()
                                    throws PortalException

Retrieves the current situation statistics of the queue.

Returns:

statistics.

Throws:

PortalException

Since:

6.1.0

reprocess

void reprocess(String processId)
               throws PortalException

Triggers the process to be retried.

Parameters:

processId - id of the process to be reprocessed.

Throws:

PortalException

Since:

6.1.0