gnu.hylafax
Interface Job

All Known Implementing Classes:

Job

public interface Job

Defines a FAX Job.

See Also:

ClientProtocol, Client

Field Summary

static java.lang.String	CHOP_DEFAULT
static java.lang.String	NOTIFY_ALL
static java.lang.String	NOTIFY_DONE
static java.lang.String	NOTIFY_NONE
static java.lang.String	NOTIFY_REQUEUE
static int	PRIORITY_BULK
static int	PRIORITY_HIGH
static int	PRIORITY_NORMAL
static int	RESOLUTION_LOW
static int	RESOLUTION_MEDIUM

Method Summary

void	addDocument(java.lang.String value)
int	getChopThreshold()
java.lang.String	getDialstring()
java.lang.String	getDocumentName()
java.lang.String	getFromUser()
long	getId() get the job-id of this Job instance.
java.lang.String	getJobInfo() Get JobInfo attribute.
java.lang.String	getKilltime()
int	getMaximumDials()
int	getMaximumTries()
java.lang.String	getNotifyAddress()
java.lang.String	getNotifyType()
java.lang.String	getPageChop()
java.awt.Dimension	getPageDimension()
int	getPageLength()
int	getPageWidth()
int	getPriority()
java.lang.String	getProperty(java.lang.String key) Get the value for an arbitrary property for this job.
java.lang.String	getRetrytime()
java.lang.String	getTagline() Get TagLine format attribute.
boolean	getUseTagline() Get the UseTagLine attribute.
int	getVerticalResolution()
void	setChopThreshold(int value)
void	setDialstring(java.lang.String value)
void	setFromUser(java.lang.String value)
void	setJobInfo(java.lang.String value) Set the JobInfo attribute.
void	setKilltime(java.lang.String value)
void	setMaximumDials(int value)
void	setMaximumTries(int value)
void	setNotifyAddress(java.lang.String value)
void	setNotifyType(java.lang.String value) set the notification type.
void	setPageChop(java.lang.String value)
void	setPageDimension(java.awt.Dimension value) Set the job's pagesize.
void	setPageLength(int length)
void	setPageWidth(int width)
void	setPriority(int value)
void	setProperty(java.lang.String property, int value) Set any arbitrary property on this job to an integer value.
void	setProperty(java.lang.String parameter, java.lang.String value) Set any arbitrary property on this job.
void	setRetrytime(java.lang.String value)
void	setSendTime(java.util.Date sendTime) Set the SENDTIME attribute.
void	setSendTime(java.lang.String sendTime) Set the SENDTIME attribute.
void	setTagline(java.lang.String value) Set the TagLine format attribute.
void	setUseTagline(boolean f) Set the UseTagLine format attribute.
void	setVerticalResolution(int value)

Field Detail

PRIORITY_NORMAL

public static final int PRIORITY_NORMAL

PRIORITY_BULK

public static final int PRIORITY_BULK

PRIORITY_HIGH

public static final int PRIORITY_HIGH

RESOLUTION_LOW

public static final int RESOLUTION_LOW

RESOLUTION_MEDIUM

public static final int RESOLUTION_MEDIUM

NOTIFY_NONE

public static final java.lang.String NOTIFY_NONE

NOTIFY_DONE

public static final java.lang.String NOTIFY_DONE

NOTIFY_REQUEUE

public static final java.lang.String NOTIFY_REQUEUE

NOTIFY_ALL

public static final java.lang.String NOTIFY_ALL

CHOP_DEFAULT

public static final java.lang.String CHOP_DEFAULT

Method Detail

getFromUser

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

getKilltime

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

getMaximumDials

public int getMaximumDials()
                    throws ServerResponseException,
                           java.io.IOException

getMaximumTries

public int getMaximumTries()
                    throws ServerResponseException,
                           java.io.IOException

getPriority

public int getPriority()
                throws ServerResponseException,
                       java.io.IOException

getDialstring

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

getNotifyAddress

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

getVerticalResolution

public int getVerticalResolution()
                          throws ServerResponseException,
                                 java.io.IOException

getPageDimension

public java.awt.Dimension getPageDimension()
                                    throws ServerResponseException,
                                           java.io.IOException

getPageWidth

public int getPageWidth()
                 throws ServerResponseException,
                        java.io.IOException

getPageLength

public int getPageLength()
                  throws ServerResponseException,
                         java.io.IOException

getNotifyType

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

getPageChop

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

getChopThreshold

public int getChopThreshold()
                     throws ServerResponseException,
                            java.io.IOException

getDocumentName

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

getRetrytime

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

getJobInfo

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

Get JobInfo attribute. JobInfo is an identifying string associated with the job.

getTagline

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

Get TagLine format attribute. The TagLine

getUseTagline

public boolean getUseTagline()
                      throws ServerResponseException,
                             java.io.IOException

Get the UseTagLine attribute. The TagLine

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.

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

getId

public long getId()

get the job-id of this Job instance.

Returns:

job id

setFromUser

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

setKilltime

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

setMaximumDials

public void setMaximumDials(int value)
                     throws ServerResponseException,
                            java.io.IOException

setMaximumTries

public void setMaximumTries(int value)
                     throws ServerResponseException,
                            java.io.IOException

setPriority

public void setPriority(int value)
                 throws ServerResponseException,
                        java.io.IOException

setDialstring

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

setNotifyAddress

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

setVerticalResolution

public void setVerticalResolution(int value)
                           throws ServerResponseException,
                                  java.io.IOException

setPageDimension

public void setPageDimension(java.awt.Dimension value)
                      throws ServerResponseException,
                             java.io.IOException

Set the job's pagesize.

See Also:

for common pagesizes

setPageWidth

public void setPageWidth(int width)
                  throws ServerResponseException,
                         java.io.IOException

setPageLength

public void setPageLength(int length)
                   throws ServerResponseException,
                          java.io.IOException

setNotifyType

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

set the notification type. For possible values, see the NOTIFY_* members of this class.

Parameters:

value - the new notification type

Throws:

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

java.io.IOException - an IO error occurred while communicating with the server

setPageChop

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

setChopThreshold

public void setChopThreshold(int value)
                      throws ServerResponseException,
                             java.io.IOException

addDocument

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

setRetrytime

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

setJobInfo

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

Set the JobInfo attribute. This is an identifying string associated with each job.

setTagline

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

Set the TagLine format attribute. This property specifies the format of the tagline rendered at the top of each page of the transmitted FAX. Tagline format strings are documented in config(5F). If you use this, you will probably want to use setUseTagline()

setUseTagline

public void setUseTagline(boolean f)
                   throws ServerResponseException,
                          java.io.IOException

Set the UseTagLine format attribute. This is an

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.

Throws:

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

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

setProperty

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

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

Throws:

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

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

setSendTime

public void setSendTime(java.util.Date sendTime)
                 throws ServerResponseException,
                        java.io.IOException

Set the SENDTIME attribute. This allows for queuing up faxes and sending them at a specific time.

Parameters:

sendTime -

Throws:

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

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

setSendTime

public void setSendTime(java.lang.String sendTime)
                 throws ServerResponseException,
                        java.io.IOException

Set the SENDTIME attribute. Must be in the format yyyyMMddHHmm and in GMT time. This allows for queuing up faxes and sending them at a specific time.

Parameters:

sendTime -

Throws:

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

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