Package com.gentics.contentnode.rest.resource.impl.internal

Class JobStatus

java.lang.Object

com.gentics.contentnode.rest.model.response.GenericResponse

com.gentics.contentnode.rest.resource.impl.internal.JobStatus

All Implemented Interfaces:

Serializable

public class JobStatus
extends GenericResponse

Response containing the job status for a background job

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected JobProgress	progress	Progress
protected boolean	running	Flag whether the job is currently running

Constructor Summary

Constructors

Constructor	Description
JobStatus()	Empty constructor
JobStatus(String name, boolean running)	Create an instance with running flag and (automatic) message

Method Summary

Modifier and Type	Method	Description
JobProgress	getProgress()	Get job progress
boolean	isRunning()	True when the job is running, false if not
JobStatus	setProgress(JobProgress progress)	Set job progress
JobStatus	setRunning(boolean running)	Set whether the job is currently running

Methods inherited from class com.gentics.contentnode.rest.model.response.GenericResponse

addMessage, getMessages, getResponseInfo, setMessages, setResponseInfo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

running

protected boolean running

Flag whether the job is currently running

progress

protected JobProgress progress

Progress

Constructor Details

JobStatus

public JobStatus()

Empty constructor

JobStatus

public JobStatus(String name,
 boolean running)

Create an instance with running flag and (automatic) message

Parameters:

name - job name

running - running flag

Method Details

isRunning

public boolean isRunning()

True when the job is running, false if not

Returns:

true for running

setRunning

public JobStatus setRunning(boolean running)

Set whether the job is currently running

Parameters:

running - true for runnin job

Returns:

fluent API

getProgress

public JobProgress getProgress()

Get job progress

Returns:

progress

setProgress

public JobStatus setProgress(JobProgress progress)

Set job progress

Parameters:

progress - progress

Returns:

fluent API