|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Task
Task interface
Method Summary | |
---|---|
void |
cancel()
Cancels the task |
void |
execute()
Executes the task |
String |
getCreator()
Returns the creator of the task |
String |
getDescription()
Returns the description of the task |
Date |
getEndTime()
The end time of the task |
List<String> |
getHistory()
Full history of all status updates to the task |
String |
getId()
Returns the internal id of the task |
String |
getName()
Returns the name of the task |
int |
getProgress()
Returns how far the task has progressed down the progress bar. |
int |
getProgressSize()
Returns the total size of the progress bar. |
Date |
getStartTime()
The start time of the task |
String |
getStatus()
Current status of the task |
Throwable |
getThrowable()
If the task resulted in an error, retrieves the throwable obtained by the task worker thread. |
void |
increment()
Increments the progress |
boolean |
isCancelled()
Whether the task was cancelled |
boolean |
isError()
Whether the task resulted in an error |
boolean |
isFinished()
Whether the tasks completed |
boolean |
isRunning()
Whether the task is still running |
boolean |
isSuccess()
Whether the task completed successfully |
void |
setCreator(String creator)
Sets the creator of the task |
void |
setDescription(String description)
Sets a description for the task |
void |
setStatus(String status)
Sets the status |
Method Detail |
---|
String getId()
String getName()
void setDescription(String description)
description
- String getDescription()
void setCreator(String creator)
creator
- String getCreator()
int getProgress()
int getProgressSize()
void increment()
void execute() throws Throwable
Throwable
void cancel()
boolean isError()
boolean isSuccess()
boolean isFinished()
boolean isRunning()
boolean isCancelled()
Date getStartTime()
Date getEndTime()
Throwable getThrowable()
void setStatus(String status)
status
- String getStatus()
List<String> getHistory()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |