Package com.atlassian.jira.task
Class TaskProgressEvent
java.lang.Object
com.atlassian.jira.task.TaskProgressEvent
- All Implemented Interfaces:
Serializable
Event that represents the progress of a long running task.
- Since:
- v3.13
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionTaskProgressEvent
(Long taskId, long elapsedRunTime, long taskProgress, String currentSubTask, String message) Create an event and initialise it with the passed parameters. -
Method Summary
Modifier and TypeMethodDescriptionFind the time the event was created.This returns the name of the current sub-task stored in the event.long
Return the elasped run time stored in the event.Get the message associated with the event.Gets the id of theTaskDescriptor
associated with the task that is running.long
The progress stored in the event.
-
Constructor Details
-
TaskProgressEvent
public TaskProgressEvent(Long taskId, long elapsedRunTime, long taskProgress, String currentSubTask, String message) Create an event and initialise it with the passed parameters.- Parameters:
taskId
- the identifier of the task that generated the event.elapsedRunTime
- the elapsed run time to store in the event.taskProgress
- the progress to store in the event.currentSubTask
- the current sub-task to store in the event.message
- the current message to store in the event.
-
-
Method Details
-
getCurrentSubTask
This returns the name of the current sub-task stored in the event. It may be null.- Returns:
- the name of the current sub-task.
-
getElapsedRunTime
public long getElapsedRunTime()Return the elasped run time stored in the event.- Returns:
- the elapsed run time.
-
getTaskProgress
public long getTaskProgress()The progress stored in the event.- Returns:
- It will commonly be a number in [0,100] to represent a percentage, though, this is left up to the task to define. A value of -1 can be returned to indicate that the progress is unknown.
-
getCreationTimeStamp
Find the time the event was created.- Returns:
- the time that this event was created. Can never be null.
-
getMessage
Get the message associated with the event.- Returns:
- the message associated with the event
-
getTaskId
Gets the id of theTaskDescriptor
associated with the task that is running.- Returns:
- the id of the
TaskDescriptor
associated with the task that is running. It cannot be null.
-