org.overlord.dtgov.taskapi

Class TaskApi

java.lang.Object

org.overlord.dtgov.taskapi.TaskApi

public class TaskApi
extends Object

Author:

eric.wittmann@redhat.com

Constructor Summary

Constructors

Constructor and Description
TaskApi() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected String	assertCurrentUser(javax.servlet.http.HttpServletRequest httpRequest) Asserts that a user is logged in and then returns the user's id.
TaskType	claimTask(javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to claim a task.
TaskType	completeTask(TaskDataType taskData, javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to complete a task.
TaskType	failTask(TaskDataType taskData, javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to fail a task.
FindTasksResponse	findTasks(FindTasksRequest findTasksRequest, javax.servlet.http.HttpServletRequest httpRequest) Gets a list of all tasks for the authenticated user.
TaskType	getTask(javax.servlet.http.HttpServletRequest httpRequest, long taskId) Fetches a single task by its unique ID.
protected void	handleException(Exception error) Handles an exception that comes out of one of the task operations.
FindTasksResponse	listTasks(javax.servlet.http.HttpServletRequest httpRequest, Integer startIndex, Integer endIndex, String orderBy, Boolean orderAscending, String status, Integer priority) Gets a list of all tasks for the authenticated user.
TaskType	releaseTask(javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to release a task.
TaskType	startTask(javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to start a task.
TaskType	stopTask(javax.servlet.http.HttpServletRequest httpRequest, long taskId) Called to stop a task.

Methods inherited from class java.lang.Object

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

Constructor Detail

TaskApi

public TaskApi()

Constructor.

Method Detail

listTasks

public FindTasksResponse listTasks(@Context
                          javax.servlet.http.HttpServletRequest httpRequest,
                          Integer startIndex,
                          Integer endIndex,
                          String orderBy,
                          Boolean orderAscending,
                          String status,
                          Integer priority)
                            throws Exception

Gets a list of all tasks for the authenticated user.

Parameters:

uri -

Throws:

Exception

findTasks

public FindTasksResponse findTasks(FindTasksRequest findTasksRequest,
                          @Context
                          javax.servlet.http.HttpServletRequest httpRequest)
                            throws Exception

Gets a list of all tasks for the authenticated user. Filters the list based on the criteria included in the FindTasksRequest.

Parameters:

findTasksRequest -

httpRequest -

Throws:

Exception

getTask

public TaskType getTask(@Context
               javax.servlet.http.HttpServletRequest httpRequest,
               long taskId)
                 throws Exception

Fetches a single task by its unique ID.

Parameters:

httpRequest -

taskId -

Throws:

Exception

claimTask

public TaskType claimTask(@Context
                 javax.servlet.http.HttpServletRequest httpRequest,
                 long taskId)
                   throws Exception

Called to claim a task.

Parameters:

httpRequest -

taskId -

Throws:

Exception

releaseTask

public TaskType releaseTask(@Context
                   javax.servlet.http.HttpServletRequest httpRequest,
                   long taskId)
                     throws Exception

Called to release a task.

Parameters:

httpRequest -

taskId -

Throws:

Exception

startTask

public TaskType startTask(@Context
                 javax.servlet.http.HttpServletRequest httpRequest,
                 long taskId)
                   throws Exception

Called to start a task.

Parameters:

httpRequest -

taskId -

Throws:

Exception

stopTask

public TaskType stopTask(@Context
                javax.servlet.http.HttpServletRequest httpRequest,
                long taskId)
                  throws Exception

Called to stop a task.

Parameters:

httpRequest -

taskId -

Throws:

Exception

completeTask

public TaskType completeTask(TaskDataType taskData,
                    @Context
                    javax.servlet.http.HttpServletRequest httpRequest,
                    long taskId)
                      throws Exception

Called to complete a task.

Parameters:

taskData -

httpRequest -

taskId -

Throws:

Exception

failTask

public TaskType failTask(TaskDataType taskData,
                @Context
                javax.servlet.http.HttpServletRequest httpRequest,
                long taskId)
                  throws Exception

Called to fail a task.

Parameters:

httpRequest -

taskId -

Throws:

Exception

handleException

protected void handleException(Exception error)
                        throws Exception

Handles an exception that comes out of one of the task operations. This provides a common way to handle transaction rollbacks (when necessary) and also re-throws the appropriate exceptions.

Parameters:

error -

Throws:

Exception

assertCurrentUser

protected String assertCurrentUser(javax.servlet.http.HttpServletRequest httpRequest)
                            throws Exception

Asserts that a user is logged in and then returns the user's id.

Parameters:

httpRequest -

Throws:

Exception