com.interstarinc.xmedius.sendfax.model
Interface IFaxOptions

All Known Implementing Classes:

DefaultFaxModel.DefaultFaxOptions

public interface IFaxOptions

This interface defines the fax options properties getters. The fax server uses these settings when transmitting the fax.

Version:

$Revision: 1.6 $

Author:

André Morin

Method Summary

BooleanValue	getFailureNotified() Required.
FaxPriority	getFaxPriority() Required.
FaxResolution	getFaxResolution() Required.
String	getNotificationAddress() Required.
Gateway	getNotificationGateway() Required.
Integer	getNumberOfRetries() Required.
BooleanValue	getSuccessNotified() Required.

Method Detail

getNumberOfRetries

Integer getNumberOfRetries()

Required.

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:

getFailureNotified()

getFaxPriority

FaxPriority getFaxPriority()

Required.

Returns:

The priority of this fax.

getSuccessNotified

BooleanValue getSuccessNotified()

Required.

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.

getFailureNotified

BooleanValue getFailureNotified()

Required.

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.

getNotificationAddress

String getNotificationAddress()

Required.

Returns:

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

getNotificationGateway

Gateway getNotificationGateway()

Required.

Returns:

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

getFaxResolution

FaxResolution getFaxResolution()

Required.

Returns:

The fax resolution.