com.xebialabs.deployit.core.api
Interface TaskProxy

public interface TaskProxy

Method Summary

javax.ws.rs.core.Response	abort(java.lang.String taskId)
javax.ws.rs.core.Response	cancel(java.lang.String taskId)
javax.ws.rs.core.Response	getStepInfo(java.lang.String taskId, int stepNr, Date ifModifiedSince) Retrieves information about a step.
javax.ws.rs.core.Response	getStepsForTask(java.lang.String taskId)
javax.ws.rs.core.Response	getTaskInfo(java.lang.String taskId)
javax.ws.rs.core.Response	getUnfinishedTasks()
javax.ws.rs.core.Response	moveStep(java.lang.String taskId, int stepNr, int newPosition)
javax.ws.rs.core.Response	start(java.lang.String taskId)
javax.ws.rs.core.Response	stop(java.lang.String taskId)
javax.ws.rs.core.Response	toggleSkipSteps(java.lang.String taskId, java.lang.String stepIds)

Method Detail

getUnfinishedTasks

javax.ws.rs.core.Response getUnfinishedTasks()

getStepsForTask

javax.ws.rs.core.Response getStepsForTask(java.lang.String taskId)

start

javax.ws.rs.core.Response start(java.lang.String taskId)

cancel

javax.ws.rs.core.Response cancel(java.lang.String taskId)

stop

javax.ws.rs.core.Response stop(java.lang.String taskId)

abort

javax.ws.rs.core.Response abort(java.lang.String taskId)

getTaskInfo

javax.ws.rs.core.Response getTaskInfo(java.lang.String taskId)

toggleSkipSteps

javax.ws.rs.core.Response toggleSkipSteps(java.lang.String taskId,
                                          java.lang.String stepIds)

moveStep

javax.ws.rs.core.Response moveStep(java.lang.String taskId,
                                   int stepNr,
                                   int newPosition)

getStepInfo

javax.ws.rs.core.Response getStepInfo(java.lang.String taskId,
                                      int stepNr,
                                      @HeaderParam(value="If-Modified-Since")
                                      Date ifModifiedSince)

Retrieves information about a step.

Parameters:

taskId - the ID of the task

stepNr - the ordinal number of the step, starting from 1

ifModifiedSince - the if-modified-since date in RFC 1123 (RFC 822 with 4-digit years) date format.

Returns:

if the step has not been modified since ifModifiedSince, a Response with a status code of 304 (Not Modified), otherwise a Response with a status code of 200 (OK) and an entity of type StepInfo.