com.gentics.contentnode.rest.model.response.admin

Class PublishInfoResponse

java.lang.Object

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

com.gentics.contentnode.rest.model.response.admin.PublishInfoResponse

All Implemented Interfaces:

Serializable

public class PublishInfoResponse
extends GenericResponse

Response containing information about the current or last publish process

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	estimatedDuration
protected boolean	failed
protected ObjectCount	files
protected ObjectCount	folders
protected ObjectCount	forms
protected Boolean	lastFailed
protected ObjectCount	pages
protected String	phase
protected int	phaseCount
protected int	phaseETA
protected int	phaseNumber
protected int	progress
protected boolean	running
protected String	status
protected int	totalWork
protected int	totalWorkDone

Constructor Summary

Constructors

Constructor and Description
PublishInfoResponse()

Method Summary

Modifier and Type	Method and Description
int	getEstimatedDuration() Estimated remaining duration in seconds.
ObjectCount	getFiles() File counts
ObjectCount	getFolders() Folder counts
ObjectCount	getForms() Form counts
Boolean	getLastFailed() Flag to mark if the previous publish process failed.
ObjectCount	getPages() Page counts
String	getPhase() Name of the current publish process phase
int	getProgress() Progress in percent
int	getTotalWork() Total number of work items of the current publish process
int	getTotalWorkDone() Number of work items done
boolean	isFailed() Flag to mark failed publish process
boolean	isRunning() True when the publish process is currently running
void	setEstimatedDuration(int estimatedDuration) Set ETA
void	setFailed(boolean failed) Set failed flag
void	setFiles(ObjectCount files) Set file counts
void	setFolders(ObjectCount folders) Set folder counts
void	setForms(ObjectCount forms) Form counts
void	setLastFailed(Boolean lastFailed) Set failed flag for the previous publish process.
void	setPages(ObjectCount pages) Page counts
void	setPhase(String phase) Set name of current publish process phase
void	setProgress(int progress) Set progress in percent
void	setRunning(boolean running) Set running flag
void	setTotalWork(int totalWork) Set total work items
void	setTotalWorkDone(int totalWorkDone) Get number of work items done

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 Detail

failed

protected boolean failed

lastFailed

protected Boolean lastFailed

status

protected String status

progress

protected int progress

estimatedDuration

protected int estimatedDuration

running

protected boolean running

totalWork

protected int totalWork

totalWorkDone

protected int totalWorkDone

phase

protected String phase

phaseNumber

protected int phaseNumber

phaseCount

protected int phaseCount

phaseETA

protected int phaseETA

files

protected ObjectCount files

folders

protected ObjectCount folders

pages

protected ObjectCount pages

forms

protected ObjectCount forms

Constructor Detail

PublishInfoResponse

public PublishInfoResponse()

Method Detail

isFailed

public boolean isFailed()

Flag to mark failed publish process

Returns:

true if publish process failed

setFailed

public void setFailed(boolean failed)

Set failed flag

Parameters:

failed - flag

getLastFailed

public Boolean getLastFailed()

Flag to mark if the previous publish process failed.

Returns:

true if the previous publish process failed, false if it was successful, and null if the is no previous publish process

setLastFailed

public void setLastFailed(Boolean lastFailed)

Set failed flag for the previous publish process.

Parameters:

lastFailed - flag

getProgress

public int getProgress()

Progress in percent

Returns:

progress

setProgress

public void setProgress(int progress)

Set progress in percent

Parameters:

progress - progress

getEstimatedDuration

public int getEstimatedDuration()

Estimated remaining duration in seconds.

Returns:

ETA in seconds

setEstimatedDuration

public void setEstimatedDuration(int estimatedDuration)

Set ETA

Parameters:

estimatedDuration - ETA in seconds

isRunning

public boolean isRunning()

True when the publish process is currently running

Returns:

true for running

setRunning

public void setRunning(boolean running)

Set running flag

Parameters:

running - flag

getTotalWork

public int getTotalWork()

Total number of work items of the current publish process

Returns:

total work

setTotalWork

public void setTotalWork(int totalWork)

Set total work items

Parameters:

totalWork - items

getTotalWorkDone

public int getTotalWorkDone()

Number of work items done

Returns:

work done

setTotalWorkDone

public void setTotalWorkDone(int totalWorkDone)

Get number of work items done

Parameters:

totalWorkDone - done

getPhase

public String getPhase()

Name of the current publish process phase

Returns:

phase name

setPhase

public void setPhase(String phase)

Set name of current publish process phase

Parameters:

phase - name

getFiles

public ObjectCount getFiles()

File counts

Returns:

file counts

setFiles

public void setFiles(ObjectCount files)

Set file counts

Parameters:

files - founts

getFolders

public ObjectCount getFolders()

Folder counts

Returns:

folder counts

setFolders

public void setFolders(ObjectCount folders)

Set folder counts

Parameters:

folders - countes

getPages

public ObjectCount getPages()

Page counts

Returns:

page counts

setPages

public void setPages(ObjectCount pages)

Page counts

Parameters:

pages - counts

getForms

public ObjectCount getForms()

Form counts

Returns:

form counts

setForms

public void setForms(ObjectCount forms)

Form counts

Parameters:

forms - counts