com.compoze.exchange.webdav
Class Priority

java.lang.Object

  |

  +--com.compoze.exchange.webdav.Priority

public class Priority

extends java.lang.Object

This class indicates the priority level. The internationalizable string values are stored in the exchange_resources.properties file (accessed through ExchangeProperties) and referenced by their key.

Field Summary

static Priority	NON_URGENT This value represents a 'non-urgent' priority level.
static Priority	NORMAL This value represents a 'normal' priority level.
static int	STORE_VALUE_NON_URGENT This value represents the 'non-urgent' store value.
static int	STORE_VALUE_NORMAL This value represents the 'normal' store value.
static int	STORE_VALUE_URGENT This value represents the 'urgent' store value.
static java.lang.String	STRING_STORE_VALUE_NON_URGENT This value represents the 'non-urgent' store value.
static java.lang.String	STRING_STORE_VALUE_NORMAL This value represents the 'normal' store value.
static java.lang.String	STRING_STORE_VALUE_URGENT This value represents the 'urgent' store value.
static Priority	URGENT This value represents a 'urgent' priority level.

Method Summary

boolean	equals(java.lang.Object o) Checks whether some other Priority object is "equal to" this one.
static Priority	get(int iStoreValue) Gets the priority by the store value.
static Priority	get(java.lang.String sStoreValue) Gets the priority by the store value.
static Priority	getByKey(java.lang.String sName) Deprecated. This method has been deprecated and will be removed by version 3.1.
static Priority	getByStoreValue(java.lang.String sStoreValue) Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with get(String)
static java.util.List	getList() Gets the list of priority levels.
java.lang.String	getName() Gets the name of the priority level using the system default locale.
java.lang.String	getName(java.util.Locale locale) Gets the name of the priority level using the specified locale.
int	getStoreValue() Gets the store value used to store the priority level in the storage system.
java.lang.Object	getStoreValueObject() Gets the store value as an object.
java.lang.String	getStoreValueString() Gets the store value as a string.
java.lang.String	toString() Returns a string representation of the object.
java.lang.String	toString(java.util.Locale locale) Returns a string representation of the object.

Methods inherited from class java.lang.Object

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

Field Detail

STORE_VALUE_NON_URGENT

public static final int STORE_VALUE_NON_URGENT

This value represents the 'non-urgent' store value.

STORE_VALUE_NORMAL

public static final int STORE_VALUE_NORMAL

This value represents the 'normal' store value.

STORE_VALUE_URGENT

public static final int STORE_VALUE_URGENT

This value represents the 'urgent' store value.

STRING_STORE_VALUE_NON_URGENT

public static final java.lang.String STRING_STORE_VALUE_NON_URGENT

This value represents the 'non-urgent' store value.

NOTE: This method is for internal use only within the WebDAV API.

STRING_STORE_VALUE_NORMAL

public static final java.lang.String STRING_STORE_VALUE_NORMAL

This value represents the 'normal' store value.

NOTE: This method is for internal use only within the WebDAV API.

STRING_STORE_VALUE_URGENT

public static final java.lang.String STRING_STORE_VALUE_URGENT

This value represents the 'urgent' store value.

NOTE: This method is for internal use only within the WebDAV API.

NON_URGENT

public static final Priority NON_URGENT

This value represents a 'non-urgent' priority level.

NORMAL

public static final Priority NORMAL

This value represents a 'normal' priority level.

URGENT

public static final Priority URGENT

This value represents a 'urgent' priority level.

Method Detail

getName

public java.lang.String getName()

Gets the name of the priority level using the system default locale.

Returns:

the name

getName

public java.lang.String getName(java.util.Locale locale)

Gets the name of the priority level using the specified locale.

Parameters:

locale - the locale

Returns:

the name

getStoreValue

public int getStoreValue()

Gets the store value used to store the priority level in the storage system.

Returns:

the store value

getStoreValueObject

public java.lang.Object getStoreValueObject()

Gets the store value as an object.

Returns:

the store value

getStoreValueString

public java.lang.String getStoreValueString()

Gets the store value as a string.

This method returns the string value of the Priority object that is stored in the Exchange store in the WebDAV property urn:schemas:mailheader:priority.

NOTE: This method is for internal use only within the WebDAV API.

Returns:

the store value

get

public static Priority get(int iStoreValue)

Gets the priority by the store value.

Parameters:

iStoreValue - the store value to get by

Returns:

the matching priority or null if not found

get

public static Priority get(java.lang.String sStoreValue)

Gets the priority by the store value.

NOTE: This method is for internal use only within the WebDAV API.

Parameters:

sStoreValue - the store value to get by

Returns:

the matching priority or null if not found

getByStoreValue

public static Priority getByStoreValue(java.lang.String sStoreValue)

Deprecated. This method has been deprecated and will be removed by version 3.1. Replaced with get(String)

Gets the priority by its store value.

Parameters:

sStoreValue - the store value

Returns:

the matching priority or null

getByKey

public static Priority getByKey(java.lang.String sName)

Deprecated. This method has been deprecated and will be removed by version 3.1.

Gets the priority by the name in the system default locale.

Parameters:

sName - the name in the system default locale

Returns:

the matching priority or null if not found

getList

public static java.util.List getList()

Gets the list of priority levels.

Returns:

the list of Priority levels (unmodifiable)

equals

public boolean equals(java.lang.Object o)

Checks whether some other Priority object is "equal to" this one.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to check for equality

Returns:

true if this object is the same as the object argument; false otherwise

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the object

toString

public java.lang.String toString(java.util.Locale locale)

Returns a string representation of the object.

Parameters:

locale - the locale

Returns:

the string representation of the object