com.interstarinc.xmedius.sendfax.model
Interface IFaxModel

All Known Implementing Classes:

DefaultFaxModel

public interface IFaxModel

This interface defines the fax model used by the xmedius send fax library. Client software may use the default implementation class DefaultFaxModel, or adapt existing classes to implement the fax model interfaces and then, use the default implementation class to link together the fax model implementors.
If the client software has no value for an optional model property, then the getter for that property should return null. Otherwise, an empty (useless) xml element would be generated when converting the model to the XML document.
Before converting the model to a XML document, the Fax instance validates the model.
The validation rules are described along with the properties of this interface.

Version:

$Revision: 1.14 $

Author:

André Morin

See Also:

DefaultFaxModel

Method Summary

List<File>	getAttachmentList() May be required
String	getComment() May be required.
File	getCoverSheet() Required if cover sheet type is CoverSheetType.LOCAL or CoverSheetType.SERVER.
CoverSheetType	getCoverSheetType() Required.
IFaxOptions	getFaxOptions() Required.
BooleanValue	getInputFileDeleted() Required
String	getPassword() Optional
List<IRecipientInfo>	getRecipientList() Required.
ISenderInfo	getSenderInfo() Optional
String	getSubject() Optional
String	getUserId() Required

Method Detail

getUserId

String getUserId()

Required

Returns:

The fax sender user id

getPassword

String getPassword()

Optional

Returns:

The fax sender password

getSubject

String getSubject()

Optional

Returns:

The fax subject

getComment

String getComment()

May be required. The comment, the attachment list and the cover sheet type are used to determine if the fax is empty.
This fax is considered empty iff : the comment and the attachment list are null or empty and the cover sheet type is CoverSheetType.NONE

Returns:

The fax comment

getCoverSheetType

CoverSheetType getCoverSheetType()

Required.

Returns:

This fax cover sheet type.

See Also:

getComment(), CoverSheetType

getCoverSheet

File getCoverSheet()

Required if cover sheet type is CoverSheetType.LOCAL or CoverSheetType.SERVER. Must be null otherwise.

Returns:

The cover sheet file.

getAttachmentList

List<File> getAttachmentList()

May be required

Returns:

The attachments to be transmitted with this fax.

See Also:

getComment()

getRecipientList

List<IRecipientInfo> getRecipientList()

Required. The list must not be null or empty.
All recipients must have a non empty fax number.

Returns:

The fax recipients.

getSenderInfo

ISenderInfo getSenderInfo()

Optional

Returns:

The fax sender info.

getFaxOptions

IFaxOptions getFaxOptions()

Required.

Returns:

The fax transmission settings.

getInputFileDeleted

BooleanValue getInputFileDeleted()

Required

Returns:

BooleanValue.YES if the XML Gateway deletes its temporary files (e.g attachment or local cover sheet).
BooleanValue.NO otherwise