com.interstarinc.xmedius.sendfax.model
Class DefaultFaxModel.DefaultFaxOptions

java.lang.Object
  com.interstarinc.xmedius.sendfax.model.DefaultFaxModel.DefaultFaxOptions

All Implemented Interfaces:

IFaxOptions

Enclosing class:

DefaultFaxModel

public class DefaultFaxModel.DefaultFaxOptions
extends Object
implements IFaxOptions

A default fax settings implementation.
Instances of this class must be created with newFaxOptions() methods from enclosing class.

Version:

$Revision: 1.15 $

Author:

André Morin

See Also:

DefaultFaxModel.newFaxOptions(), DefaultFaxModel.newFaxOptions(IFaxOptions)

Field Summary

private BooleanValue	failureNotified
private FaxPriority	faxPriority
private FaxResolution	faxResolution
private String	notificationAddress
private Gateway	notificationGateway
private Integer	numberOfRetries
private BooleanValue	successNotified

Constructor Summary

private	DefaultFaxModel.DefaultFaxOptions() Constructor is private to ensure instances are created with newFaxOptions() method from enclosing class.
private	DefaultFaxModel.DefaultFaxOptions(IFaxOptions faxOptions) Constructor is private to ensure instances are created with newFaxOptions(IFaxOptions) method from enclosing class.

Method Summary

BooleanValue	getFailureNotified() Required.
FaxPriority	getFaxPriority() Required.
FaxResolution	getFaxResolution() Required.
String	getNotificationAddress() Required.
Gateway	getNotificationGateway() Required.
Integer	getNumberOfRetries() Required.
BooleanValue	getSuccessNotified() Required.
void	setFailureNotified(BooleanValue failureNotified)
void	setFaxPriority(FaxPriority faxPriority)
void	setFaxResolution(FaxResolution faxResolution)
void	setNotificationAddress(String notificationAddress)
void	setNotificationGateway(Gateway notificationGateway)
void	setNumberOfRetries(Integer numberOfRetries)
void	setSuccessNotified(BooleanValue successNotified)

Methods inherited from class java.lang.Object

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

Field Detail

faxPriority

private FaxPriority faxPriority

faxResolution

private FaxResolution faxResolution

notificationAddress

private String notificationAddress

notificationGateway

private Gateway notificationGateway

numberOfRetries

private Integer numberOfRetries

failureNotified

private BooleanValue failureNotified

successNotified

private BooleanValue successNotified

Constructor Detail

DefaultFaxModel.DefaultFaxOptions

private DefaultFaxModel.DefaultFaxOptions()

Constructor is private to ensure instances are created with newFaxOptions() method from enclosing class.

DefaultFaxModel.DefaultFaxOptions

private DefaultFaxModel.DefaultFaxOptions(IFaxOptions faxOptions)

Constructor is private to ensure instances are created with newFaxOptions(IFaxOptions) method from enclosing class.

Parameters:

faxOptions - IFaxOptions instance used to initialise this class properties.

Method Detail

getFailureNotified

public BooleanValue getFailureNotified()

Description copied from interface: IFaxOptions

Required.

Specified by:

getFailureNotified in interface IFaxOptions

Returns:

BooleanValue.YES => the sender will receive a notification if the server failed to send the fax.
BooleanValue.NO => the sender will not receive a notification if the server failed to send the fax.

setFailureNotified

public void setFailureNotified(BooleanValue failureNotified)

getFaxPriority

public FaxPriority getFaxPriority()

Description copied from interface: IFaxOptions

Required.

Specified by:

getFaxPriority in interface IFaxOptions

Returns:

The priority of this fax.

setFaxPriority

public void setFaxPriority(FaxPriority faxPriority)

getFaxResolution

public FaxResolution getFaxResolution()

Description copied from interface: IFaxOptions

Required.

Specified by:

getFaxResolution in interface IFaxOptions

Returns:

The fax resolution.

setFaxResolution

public void setFaxResolution(FaxResolution faxResolution)

getNotificationAddress

public String getNotificationAddress()

Description copied from interface: IFaxOptions

Required.

Specified by:

getNotificationAddress in interface IFaxOptions

Returns:

The address used by the fax server when sending a notification.
Usually, the user's email address.

setNotificationAddress

public void setNotificationAddress(String notificationAddress)

getNotificationGateway

public Gateway getNotificationGateway()

Description copied from interface: IFaxOptions

Required.

Specified by:

getNotificationGateway in interface IFaxOptions

Returns:

The gateway used by the fax server when sending a notification.

setNotificationGateway

public void setNotificationGateway(Gateway notificationGateway)

getNumberOfRetries

public Integer getNumberOfRetries()

Description copied from interface: IFaxOptions

Required.

Specified by:

getNumberOfRetries in interface IFaxOptions

Returns:

The number of retries made by the fax server when sending a fax.
If the server failed to send the fax this number of retries, and getFailureNotified() returns BooleanValue.YES, the user sending this fax will receive a notification failure.

See Also:

IFaxOptions.getFailureNotified()

setNumberOfRetries

public void setNumberOfRetries(Integer numberOfRetries)

getSuccessNotified

public BooleanValue getSuccessNotified()

Description copied from interface: IFaxOptions

Required.

Specified by:

getSuccessNotified in interface IFaxOptions

Returns:

BooleanValue.YES => the sender will receive a notification if the server succeeded to send the fax.
BooleanValue.NO => the sender will not receive a notification if the server succeeded to send the fax.

setSuccessNotified

public void setSuccessNotified(BooleanValue successNotified)