ProgressStatusController (Gemma 1.32.1 API)

java.lang.Object
- ubic.gemma.web.controller.job.ProgressStatusController

@Controller
public class ProgressStatusController
extends Object

This class exposes methods for AJAX calls.

Author:: klc

Constructor Summary

Constructors
Constructor Description

ProgressStatusController()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addEmailAlert(String taskId)`	Set up an email alert for this job; an email will be sent when it has finished (or failed).
`boolean`	`cancelJob(String taskId)`	Attempt to cancel the job.
`Object`	`checkResult(String taskId)`
`List<ProgressData>`	`getProgressStatus(String taskId)`	Get the latest information about how a job is doing.
`SubmittedTaskValueObject`	`getSubmittedTask(String taskId)`
`Collection<SubmittedTaskValueObject>`	`getSubmittedTasks()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProgressStatusController
```
public ProgressStatusController()
```
- Method Detail
  - addEmailAlert
```
public void addEmailAlert(String taskId)
```
    Set up an email alert for this job; an email will be sent when it has finished (or failed).
    
    Parameters:
    
    taskId - task id
  - cancelJob
```
public boolean cancelJob(String taskId)
```
    Attempt to cancel the job.
    
    Parameters:
    
    taskId - tak id
    
    Returns:
    
    true if cancelling was error-free, false otherwise.
  - checkResult
```
public Object checkResult(String taskId)
                   throws Exception
```
    Throws:
    
    Exception
  - getProgressStatus
```
public List<ProgressData> getProgressStatus(String taskId)
```
    Get the latest information about how a job is doing.
    
    Parameters:
    
    taskId - id
    
    Returns:
    
    progress data
  - getSubmittedTask
```
public SubmittedTaskValueObject getSubmittedTask(String taskId)
```
  - getSubmittedTasks
```
@Secured("GROUP_ADMIN")
public Collection<SubmittedTaskValueObject> getSubmittedTasks()
```