com.interstarinc.xmedius.sendfax.model
Class CoverSheetType

java.lang.Object
  com.interstarinc.xmedius.sendfax.model.CoverSheetType

public final class CoverSheetType
extends Object

This type safe enum class defines the fax cover sheet type values The cover sheet type determines how the fax server finds the cover sheet.

Version:

$Revision: 1.5 $

Author:

André Morin

See Also:

IFaxModel.getCoverSheetType(), IFaxModel.getCoverSheet()

Field Summary

static CoverSheetType	DEFAULT DEFAULT : the fax server uses the cover sheet specified in the user profile.
static CoverSheetType	LOCAL LOCAL : the fax server uses a cover sheet uploaded has an attachment by the user.
static CoverSheetType	NONE NONE : the client sofware specified this type if the fax to be sent has no cover sheet.
static CoverSheetType	SERVER SERVER : the fax server uses a cover sheet from the user's profile, other than the default cover sheet.
private String	type

Constructor Summary

private

CoverSheetType(String type)

Method Summary

static CoverSheetType	getValueFor(String coverSheetType) A utility method to convert a String into a CoverSheetType.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final CoverSheetType NONE

NONE : the client sofware specified this type if the fax to be sent has no cover sheet. With this cover sheet type, the client software must not set the cover sheet property.

DEFAULT

public static final CoverSheetType DEFAULT

DEFAULT : the fax server uses the cover sheet specified in the user profile. With this cover sheet type, the client software must not set the cover sheet property.

SERVER

public static final CoverSheetType SERVER

SERVER : the fax server uses a cover sheet from the user's profile, other than the default cover sheet. In this case, the cover sheet property must be set to the cover sheet selected by the user.

LOCAL

public static final CoverSheetType LOCAL

LOCAL : the fax server uses a cover sheet uploaded has an attachment by the user. In this case, the cover sheet property must be set to the uploaded file name.

type

private String type

Constructor Detail

CoverSheetType

private CoverSheetType(String type)

Method Detail

toString

public String toString()

Overrides:

toString in class Object

Returns:

This cover sheet type string representation
The XML builder uses this value when converting the fax model to the XML document.

getValueFor

public static CoverSheetType getValueFor(String coverSheetType)
                                  throws IllegalArgumentException

A utility method to convert a String into a CoverSheetType.
This is the inverse of toString().

Parameters:

coverSheetType - the cover sheet type to be converted
Expected values : any value returned by toString() applied on an instance of this class.

Returns:

The CoverSheetType instance that matches the input parameter.
Comparison is case insensitive.

Throws:

IllegalArgumentException - if the input parameter is not an expected value.

See Also:

toString()