org.mapfish.print.servlet.job

Interface PrintJobStatus

All Known Implementing Classes:

PrintJobStatusExtImpl, PrintJobStatusImpl

public interface PrintJobStatus

Print Job Status.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PrintJobStatus.Status The status type.

Method Summary

Modifier and Type	Method and Description
AccessAssertion	getAccess() Get the access information.
java.lang.String	getAppId() Get the app ID.
java.util.Date	getCompletionDate() Get the completion time (as date).
java.lang.Long	getCompletionTime() Get the completion time (as long).
long	getElapsedTime() Get elapsed time.
PrintJobEntry	getEntry() Get the entry.
java.lang.String	getError() Get the error message.
java.lang.String	getReferenceId() Get the reference ID.
long	getRequestCount() Get the request count.
PrintJobResult	getResult() Get the result.
java.util.Date	getStartDate() Get the start time (as date).
long	getStartTime() Get the start time (as long).
PrintJobStatus.Status	getStatus() Get the status.
long	getWaitingTime() Get the estimated waiting time for the job to finish.
boolean	isDone() is the job done?
void	setWaitingTime(long waitingTime) Set the estimated waiting time for the job to finish (this is a transient value).

Method Detail

getEntry

PrintJobEntry getEntry()

Get the entry.

getReferenceId

java.lang.String getReferenceId()

Get the reference ID.

getAppId

java.lang.String getAppId()

Get the app ID.

getStartDate

java.util.Date getStartDate()

Get the start time (as date).

getStartTime

long getStartTime()

Get the start time (as long).

getAccess

AccessAssertion getAccess()

Get the access information.

getCompletionTime

java.lang.Long getCompletionTime()

Get the completion time (as long).

getCompletionDate

java.util.Date getCompletionDate()

Get the completion time (as date).

getRequestCount

long getRequestCount()

Get the request count.

getError

java.lang.String getError()

Get the error message.

getStatus

PrintJobStatus.Status getStatus()

Get the status.

getResult

PrintJobResult getResult()

Get the result.

getElapsedTime

long getElapsedTime()

Get elapsed time.

isDone

boolean isDone()

is the job done?

getWaitingTime

long getWaitingTime()

Get the estimated waiting time for the job to finish.

setWaitingTime

void setWaitingTime(long waitingTime)

Set the estimated waiting time for the job to finish (this is a transient value).

Parameters:

waitingTime - the waiting time