gnu.hylafax.job
Class SendEvent

java.lang.Object
  |
  +--gnu.hylafax.job.Event
        |
        +--gnu.hylafax.job.SendEvent

public class SendEvent
extends Event

This class contains the information available on a job notification.

Version:
$Id: SendEvent.java,v 1.2 2005/06/02 03:37:23 sjardine Exp $
Author:
$Author: sjardine $
See Also:
Notifier, SampleListener

Field Summary
static java.lang.String REASON_BLOCKED
          The job is blocked by other concurrent jobs
static java.lang.String REASON_DONE
          The job was completed successfully
static java.lang.String REASON_FAILED
          The job was not completed
static java.lang.String REASON_FORMATFAILED
          The job document conversion failed
static java.lang.String REASON_KILLED
          The job was removed from the queue
static java.lang.String REASON_NOFORMATTER
          The document conversion program could not be found
static java.lang.String REASON_POLLFAILED
          The document poll failed
static java.lang.String REASON_POLLNODOCUMENT
          There was no document available for polling
static java.lang.String REASON_POLLREJECTED
          The remote side rejected a document poll
static java.lang.String REASON_REJECTED
          The job was rejected
static java.lang.String REASON_REMOVED
          The job was removed from the queue
static java.lang.String REASON_REQUEUED
          The job is being requeued for another attempt
static java.lang.String REASON_TIMEDOUT
          The job could not be sent before kill timer expired
 
Constructor Summary
SendEvent()
           
 
Method Summary
 long getElapsedTime()
           
 long getJobId()
           
 java.lang.String getNextAttempt()
           
 java.lang.String getReason()
           
 void setElapsedTime(long time)
           
 void setElapsedTime(java.lang.String time)
          set the job elapsed time.
 void setJobId(long jid)
           
 void setNextAttempt(java.lang.String seconds)
           
 void setReason(java.lang.String r)
           
 
Methods inherited from class gnu.hylafax.job.Event
getFilename, setFilename
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REASON_DONE

public static final java.lang.String REASON_DONE
The job was completed successfully

REASON_FAILED

public static final java.lang.String REASON_FAILED
The job was not completed

REASON_REJECTED

public static final java.lang.String REASON_REJECTED
The job was rejected

REASON_BLOCKED

public static final java.lang.String REASON_BLOCKED
The job is blocked by other concurrent jobs

REASON_REQUEUED

public static final java.lang.String REASON_REQUEUED
The job is being requeued for another attempt

REASON_REMOVED

public static final java.lang.String REASON_REMOVED
The job was removed from the queue

REASON_KILLED

public static final java.lang.String REASON_KILLED
The job was removed from the queue

REASON_TIMEDOUT

public static final java.lang.String REASON_TIMEDOUT
The job could not be sent before kill timer expired

REASON_FORMATFAILED

public static final java.lang.String REASON_FORMATFAILED
The job document conversion failed

REASON_NOFORMATTER

public static final java.lang.String REASON_NOFORMATTER
The document conversion program could not be found

REASON_POLLREJECTED

public static final java.lang.String REASON_POLLREJECTED
The remote side rejected a document poll

REASON_POLLNODOCUMENT

public static final java.lang.String REASON_POLLNODOCUMENT
There was no document available for polling

REASON_POLLFAILED

public static final java.lang.String REASON_POLLFAILED
The document poll failed
Constructor Detail

SendEvent

public SendEvent()
Method Detail

setJobId

public void setJobId(long jid)

getJobId

public long getJobId()

getReason

public java.lang.String getReason()

setReason

public void setReason(java.lang.String r)

getElapsedTime

public long getElapsedTime()

setElapsedTime

public void setElapsedTime(long time)

setElapsedTime

public void setElapsedTime(java.lang.String time)
set the job elapsed time.
Parameters:
time - the elapsed time value in "mm:ss" format

setNextAttempt

public void setNextAttempt(java.lang.String seconds)

getNextAttempt

public java.lang.String getNextAttempt()