org.xwiki.job.event.status

Interface JobStatus

All Known Implementing Classes:

AbstractJobStatus, DefaultJobStatus

public interface JobStatus

Describe the current status of a job.

Since:

4.0M1

Version:

$Id: e770b6d3edc0a3eff56bbf3187ca7a3c861343a9 $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobStatus.State Job status.

Method Summary

Modifier and Type	Method and Description
void	answered() Indicate that the question has been answered.
void	ask(Object question)
default boolean	ask(Object question, long time, TimeUnit unit)
Date	getEndDate()
default Throwable	getError()
default String	getJobType()
LogQueue	getLog()
List<LogEvent>	getLog(LogLevel level) Deprecated. since 4.1RC1 use LogQueue.getLogs(LogLevel) instead
JobProgress	getProgress()
Object	getQuestion()
Request	getRequest()
Date	getStartDate()
JobStatus.State	getState()

Method Detail

getJobType

default String getJobType()

Returns:

the type of the job

Since:

9.2RC1

getState

JobStatus.State getState()

Returns:

the general state of the job

getError

default Throwable getError()

Returns:

the Throwable on which the job stopped

Since:

8.1RC1

getRequest

Request getRequest()

Returns:

the job request provided when starting it

getLog

LogQueue getLog()

Returns:

the log sent during job execution

getProgress

JobProgress getProgress()

Returns:

progress information about the job (percent, etc.)

ask

void ask(Object question)
  throws InterruptedException

Parameters:

question - the question to ask as a Java bean

Throws:

InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

Since:

4.0M2

ask

default boolean ask(Object question,
                    long time,
                    TimeUnit unit)
             throws InterruptedException

Parameters:

question - the question to ask as a Java bean

time - the maximum time to wait

unit - the time unit of the time argument

Returns:

false if the waiting time detectably elapsed before return from the method, else true

Throws:

InterruptedException - if the current thread is interrupted (and interruption of thread suspension is supported)

Since:

9.1RC1

getQuestion

Object getQuestion()

Returns:

the question

Since:

4.0M2

answered

void answered()

Indicate that the question has been answered.

Since:

4.0M2

getStartDate

Date getStartDate()

Returns:

the date and time when the job has been started

getEndDate

Date getEndDate()

Returns:

the date and time when the job finished

getLog

@Deprecated
List<LogEvent> getLog(LogLevel level)

Deprecated. since 4.1RC1 use LogQueue.getLogs(LogLevel) instead

Parameters:

level - the level of the log

Returns:

the log sent with the provided level