gnu.hylafax.job
Class ThreadSafeJob

java.lang.Object
  |
  +--gnu.hylafax.job.Job
        |
        +--gnu.hylafax.job.ThreadSafeJob

All Implemented Interfaces:

Job

public class ThreadSafeJob

extends Job

This is a thread-safe implementation of the gnu.hylafax.Job interface.

See Also:

ClientProtocol, Client

Fields inherited from class gnu.hylafax.job.Job

CHOP_DEFAULT, client, NOTIFY_ALL, NOTIFY_DONE, NOTIFY_NONE, NOTIFY_REQUEUE, PRIORITY_BULK, PRIORITY_HIGH, PRIORITY_NORMAL, RESOLUTION_LOW, RESOLUTION_MEDIUM

Constructor Summary

ThreadSafeJob(Client c)

ThreadSafeJob(Client c, long id)

Method Summary

java.lang.String	getProperty(java.lang.String key) Get the value for an arbitrary property for this job.
void	setProperty(java.lang.String parameter, java.lang.String value) Set any arbitrary property on this job.

Methods inherited from class gnu.hylafax.job.Job

addDocument, getChopThreshold, getDialstring, getDocumentName, getFromUser, getId, getJobInfo, getKilltime, getMaximumDials, getMaximumTries, getNotifyAddress, getNotifyType, getPageChop, getPageDimension, getPageLength, getPageWidth, getPriority, getRetrytime, getTagline, getUseTagline, getVerticalResolution, setChopThreshold, setDialstring, setFromUser, setJobInfo, setKilltime, setMaximumDials, setMaximumTries, setNotifyAddress, setNotifyType, setPageChop, setPageDimension, setPageLength, setPageWidth, setPriority, setProperty, setRetrytime, setSendTime, setSendTime, setTagline, setUseTagline, setVerticalResolution

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadSafeJob

public ThreadSafeJob(Client c)
              throws ServerResponseException,
                     java.io.IOException

ThreadSafeJob

public ThreadSafeJob(Client c,
                     long id)
              throws ServerResponseException,
                     java.io.IOException

Method Detail

getProperty

public java.lang.String getProperty(java.lang.String key)
                             throws ServerResponseException,
                                    java.io.IOException

Get the value for an arbitrary property for this job. Developers using this method should be familiar with the HylaFAX client protocol in order to provide the correct key values and how to interpret the values returned. This method is thread-safe.

Overrides:

getProperty in class Job

Returns:

a String value for the given property key

Throws:

ServerResponseException - the server responded with an error. This is likely due to a protocol error.

java.io.IOException - an i/o error occured

setProperty

public void setProperty(java.lang.String parameter,
                        java.lang.String value)
                 throws ServerResponseException,
                        java.io.IOException

Set any arbitrary property on this job. In order to use this method, developers should be familiar with the HylaFAX client protocol. This method is thread-safe.

Overrides:

setProperty in class Job

Throws:

ServerResponseException - the server responded with an error code. This is likely a protocol violation.

java.io.IOException - an i/o error occured