Package com.aquima.interactions.framework.service.task

Class TaskStatus

java.lang.Object

com.aquima.interactions.framework.service.task.TaskStatus

All Implemented Interfaces:

IService

public class TaskStatus
extends Object
implements IService

Purpose
This service can be used to direct your flow by using the status of the current active task.

Context
This service can be called when a task is activated. When no task is active, an exception will be thrown.

Result
This service returns the status of the task by the following events:

• Open
• Started
• Complete
• Canceled
• Expired

Since:

7.1

Author:

Jon van Leuven

Field Summary

Fields

Modifier and Type	Field	Description
static final IServiceResult	RESULT_CANCELED
static final IServiceResult	RESULT_COMPLETE
static final IServiceResult	RESULT_EXPIRED
static final IServiceResult	RESULT_OPEN
static final IServiceResult	RESULT_STARTED

Constructor Summary

Constructors

Constructor	Description
TaskStatus()

Method Summary

Modifier and Type	Method	Description
IServiceResult	handle(IServiceContext context)	The handle method of the service is allowed to make changes to the interfaces passed along with the IServiceContext.

Methods inherited from class java.lang.Object

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

Field Details

RESULT_OPEN

public static final IServiceResult RESULT_OPEN

RESULT_STARTED

public static final IServiceResult RESULT_STARTED

RESULT_COMPLETE

public static final IServiceResult RESULT_COMPLETE

RESULT_EXPIRED

public static final IServiceResult RESULT_EXPIRED

RESULT_CANCELED

public static final IServiceResult RESULT_CANCELED

Constructor Details

TaskStatus

public TaskStatus()

Method Details

handle

public IServiceResult handle(IServiceContext context)
                      throws ServiceException,
Exception

Description copied from interface: IService

The handle method of the service is allowed to make changes to the interfaces passed along with the IServiceContext. This means the service context is changed accordingly.

Specified by:

handle in interface IService

Parameters:

context - the context in which the service is called and allowed to make changes.

Returns:

The result of this service, may be null.

Throws:

ServiceException - When an expected exception occurs and the portal should display certain messages.

Exception - When an unexpected exception occurs and the portal should display a standard message.