Package org.apache.manifoldcf.crawler.interfaces

Class JobStatus

java.lang.Object

org.apache.manifoldcf.crawler.interfaces.JobStatus

public class JobStatus
extends java.lang.Object

This class describes the complete status of a job. It is immutable.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	_rcsid
protected java.lang.String	description
protected long	documentsInQueue
protected long	documentsOutstanding
protected long	documentsProcessed
protected long	endTime
protected java.lang.String	errorText
protected java.lang.String	jobID
static int	JOBSTATUS_ABORTING
static int	JOBSTATUS_COMPLETED
static int	JOBSTATUS_DESTRUCTING
static int	JOBSTATUS_ERROR
static int	JOBSTATUS_JOBENDCLEANUP
static int	JOBSTATUS_JOBENDNOTIFICATION
static int	JOBSTATUS_NOTYETRUN
static int	JOBSTATUS_PAUSED
static int	JOBSTATUS_RESTARTING
static int	JOBSTATUS_RESUMING
static int	JOBSTATUS_RUNNING
static int	JOBSTATUS_RUNNING_UNINSTALLED
static int	JOBSTATUS_STARTING
static int	JOBSTATUS_STOPPING
static int	JOBSTATUS_WINDOWWAIT
protected boolean	outstandingCountExact
protected boolean	processedCountExact
protected boolean	queueCountExact
protected long	startTime
protected int	status

Constructor Summary

Constructors

Constructor	Description
JobStatus(java.lang.String jobID, java.lang.String description, int status, long documentsInQueue, long documentsOutstanding, long documentsProcessed, boolean queueCountExact, boolean outstandingCountExact, boolean processedCountExact, long startTime, long endTime, java.lang.String errorText)	Constructor.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDescription()	Get the job description.
long	getDocumentsInQueue()	Get the number of documents in the queue.
long	getDocumentsOutstanding()	Get the number of documents outstanding.
long	getDocumentsProcessed()	Get the number of documents that have been processed at least once.
long	getEndTime()	Get the end time.
java.lang.String	getErrorText()	Get the error text.
java.lang.String	getJobID()	Get the job id.
boolean	getOutstandingCountExact()	Get whether the outstanding count is accurate, or an estimate.
boolean	getProcessedCountExact()	Get whether the processed count is accurate, or an estimate.
boolean	getQueueCountExact()	Get whether the queue count is accurate, or an estimate.
long	getStartTime()	Get the start time.
int	getStatus()	Get the job status.

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

JOBSTATUS_NOTYETRUN

public static final int JOBSTATUS_NOTYETRUN

See Also:

Constant Field Values

JOBSTATUS_RUNNING

public static final int JOBSTATUS_RUNNING

See Also:

Constant Field Values

JOBSTATUS_STOPPING

public static final int JOBSTATUS_STOPPING

See Also:

Constant Field Values

JOBSTATUS_PAUSED

public static final int JOBSTATUS_PAUSED

See Also:

Constant Field Values

JOBSTATUS_RESUMING

public static final int JOBSTATUS_RESUMING

See Also:

Constant Field Values

JOBSTATUS_COMPLETED

public static final int JOBSTATUS_COMPLETED

See Also:

Constant Field Values

JOBSTATUS_WINDOWWAIT

public static final int JOBSTATUS_WINDOWWAIT

See Also:

Constant Field Values

JOBSTATUS_STARTING

public static final int JOBSTATUS_STARTING

See Also:

Constant Field Values

JOBSTATUS_DESTRUCTING

public static final int JOBSTATUS_DESTRUCTING

See Also:

Constant Field Values

JOBSTATUS_ERROR

public static final int JOBSTATUS_ERROR

See Also:

Constant Field Values

JOBSTATUS_ABORTING

public static final int JOBSTATUS_ABORTING

See Also:

Constant Field Values

JOBSTATUS_RESTARTING

public static final int JOBSTATUS_RESTARTING

See Also:

Constant Field Values

JOBSTATUS_RUNNING_UNINSTALLED

public static final int JOBSTATUS_RUNNING_UNINSTALLED

See Also:

Constant Field Values

JOBSTATUS_JOBENDCLEANUP

public static final int JOBSTATUS_JOBENDCLEANUP

See Also:

Constant Field Values

JOBSTATUS_JOBENDNOTIFICATION

public static final int JOBSTATUS_JOBENDNOTIFICATION

See Also:

Constant Field Values

jobID

protected final java.lang.String jobID

description

protected final java.lang.String description

status

protected final int status

documentsInQueue

protected final long documentsInQueue

documentsOutstanding

protected final long documentsOutstanding

documentsProcessed

protected final long documentsProcessed

queueCountExact

protected final boolean queueCountExact

outstandingCountExact

protected final boolean outstandingCountExact

processedCountExact

protected final boolean processedCountExact

startTime

protected final long startTime

endTime

protected final long endTime

errorText

protected final java.lang.String errorText

Constructor Detail

JobStatus

public JobStatus(java.lang.String jobID,
                 java.lang.String description,
                 int status,
                 long documentsInQueue,
                 long documentsOutstanding,
                 long documentsProcessed,
                 boolean queueCountExact,
                 boolean outstandingCountExact,
                 boolean processedCountExact,
                 long startTime,
                 long endTime,
                 java.lang.String errorText)

Constructor.

Parameters:

jobID - is the job identifier.

description - is the job description.

status - is the job status.

documentsInQueue - is the total number of documents currently in the document queue for the job.

documentsOutstanding - is the total number of documents currently marked for processing.

documentsProcessed - is the total number of documents that have been processed at least once.

startTime - is time the job started (use -1 for never)

endTime - is the time the job ended (use -1 for not yet)

Method Detail

getJobID

public java.lang.String getJobID()

Get the job id.

Returns:

the id.

getDescription

public java.lang.String getDescription()

Get the job description.

Returns:

the description.

getStatus

public int getStatus()

Get the job status.

Returns:

the status.

getDocumentsInQueue

public long getDocumentsInQueue()

Get the number of documents in the queue.

Returns:

the number of documents in the queue.

getQueueCountExact

public boolean getQueueCountExact()

Get whether the queue count is accurate, or an estimate.

Returns:

true if accurate.

getDocumentsOutstanding

public long getDocumentsOutstanding()

Get the number of documents outstanding.

Returns:

the documents that are waiting for processing.

getOutstandingCountExact

public boolean getOutstandingCountExact()

Get whether the outstanding count is accurate, or an estimate.

Returns:

true if accurate.

getDocumentsProcessed

public long getDocumentsProcessed()

Get the number of documents that have been processed at least once.

Returns:

the document count.

getProcessedCountExact

public boolean getProcessedCountExact()

Get whether the processed count is accurate, or an estimate.

Returns:

true if accurate.

getStartTime

public long getStartTime()

Get the start time.

Returns:

the start time, or -1

getEndTime

public long getEndTime()

Get the end time.

Returns:

the end time, or -1

getErrorText

public java.lang.String getErrorText()

Get the error text.

Returns:

the text, or null.