@Role public interface JobProgressManager
Modifier and Type | Method and Description |
---|---|
<T> T |
call(Callable<T> task,
int steps,
Object source)
Automatically push and pop progression level around passed task.
|
<T> T |
call(Callable<T> task,
Object source)
Automatically push and pop progression level with unknown number of steps around passed task.
|
void |
endStep(Object source)
Close the current step.
|
void |
popLevelProgress(Object source)
Pop current progression level.
|
void |
pushLevelProgress(int steps,
Object source)
Push new progression level.
|
void |
pushLevelProgress(Object source)
Push new progression level with unknown number of steps.
|
void |
startStep(Object source)
Close the current step if any and start a new one with provided name.
|
void |
startStep(Object source,
org.xwiki.logging.Message message)
Close the current step if any and start a new one with provided name.
|
void |
startStep(Object source,
String name)
Close the current step if any and start a new one with provided name.
|
void |
startStep(Object source,
String translationKey,
String message,
Object... arguments)
Close the current step if any and start a new one with provided name.
|
void |
stepPropress(Object source)
Deprecated.
since 7.1M2, use
startStep(Object) instead |
void pushLevelProgress(Object source)
source
- the source to send with the eventvoid pushLevelProgress(int steps, Object source)
steps
- number of steps in this new levelsource
- the source to send with the event@Deprecated void stepPropress(Object source)
startStep(Object)
insteadsource
- the source to send with the eventvoid startStep(Object source)
source
- the source to send with the eventvoid startStep(Object source, String name)
source
- the source to send with the eventname
- the name associated to the next stepvoid startStep(Object source, String translationKey, String message, Object... arguments)
source
- the source to send with the eventtranslationKey
- the key used to find the translation of the step messagemessage
- the default message associated to the steparguments
- the arguments to insert in the step messagevoid startStep(Object source, org.xwiki.logging.Message message)
source
- the source to send with the eventmessage
- the message associated to the next stepvoid endStep(Object source)
source
- the source to send with the eventvoid popLevelProgress(Object source)
source
- the source to send with the event<T> T call(Callable<T> task, Object source) throws Exception
T
- the return typetask
- the task to executesource
- the source to send with the eventException
- if unable to compute a result<T> T call(Callable<T> task, int steps, Object source) throws Exception
T
- the return typetask
- the task to executesteps
- number of steps in this new levelsource
- the source to send with the eventException
- if unable to compute a resultCopyright © 2004–2021 XWiki. All rights reserved.