Compoze Software, Inc.

com.compoze.exchange
Class Importance

java.lang.Object
  extended bycom.compoze.exchange.Importance
All Implemented Interfaces:
java.io.Serializable

public class Importance
extends java.lang.Object
implements java.io.Serializable

This class stores the values for an 'importance'. The internationalizable string values are stored in the exchange_resources.properties file (accessed through ExchangeProperties) and referenced by their key.

See Also:
Serialized Form

Field Summary
static Importance HIGH
          This value represents a 'High' importance.
static Importance LOW
          This value represents a 'Low' importance.
static Importance NORMAL
          This value represents a 'Normal' importance.
static int STORE_VALUE_HIGH
          This value represents the 'High' store value.
static int STORE_VALUE_LOW
          This value represents the 'Low' store value.
static int STORE_VALUE_NORMAL
          This value represents the 'Normal' store value.
static java.lang.String STRING_STORE_VALUE_HIGH
          This value represents the 'High' store value.
static java.lang.String STRING_STORE_VALUE_LOW
          This value represents the 'Low' store value.
static java.lang.String STRING_STORE_VALUE_NORMAL
          This value represents the 'Normal' store value.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static Importance get(int iStoreValue)
          Gets the importance by the store value.
static Importance get(java.lang.String sStoreValue)
          Gets the importance by the store value.
static java.util.List getList()
          Gets the list of importance levels.
 java.lang.String getName()
          Gets the name of the importance using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the importance level using the specified locale.
 int getStoreValue()
          Gets the store value used to store the importance 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_LOW

public static final int STORE_VALUE_LOW
This value represents the 'Low' store value.

See Also:
Constant Field Values

STORE_VALUE_NORMAL

public static final int STORE_VALUE_NORMAL
This value represents the 'Normal' store value.

See Also:
Constant Field Values

STORE_VALUE_HIGH

public static final int STORE_VALUE_HIGH
This value represents the 'High' store value.

See Also:
Constant Field Values

STRING_STORE_VALUE_LOW

public static final java.lang.String STRING_STORE_VALUE_LOW
This value represents the 'Low' store value.

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

See Also:
Constant Field Values

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.

See Also:
Constant Field Values

STRING_STORE_VALUE_HIGH

public static final java.lang.String STRING_STORE_VALUE_HIGH
This value represents the 'High' store value.

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

See Also:
Constant Field Values

LOW

public static final Importance LOW
This value represents a 'Low' importance.


NORMAL

public static final Importance NORMAL
This value represents a 'Normal' importance.


HIGH

public static final Importance HIGH
This value represents a 'High' importance.

Method Detail

getName

public java.lang.String getName()
Gets the name of the importance using the system default locale.

Returns:
the name

getName

public java.lang.String getName(java.util.Locale locale)
Gets the name of the importance level using the specified locale.

Parameters:
locale - the locale
Returns:
the name

getStoreValue

public int getStoreValue()
Gets the store value used to store the importance 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 Importance object that is stored in the Exchange store in the WebDAV property urn:schemas:mailheader:importance.

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

Returns:
the store value

get

public static Importance get(int iStoreValue)
Gets the importance by the store value.

Parameters:
iStoreValue - the store value to get by
Returns:
the matching importance or null if not found

get

public static Importance get(java.lang.String sStoreValue)
Gets the importance 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 importance or null if not found

getList

public static java.util.List getList()
Gets the list of importance levels.

Returns:
the list of Importance objects (unmodifiable)

equals

public boolean equals(java.lang.Object o)
Checks for equality. The store value is used to determine equality.

Parameters:
o - the object to check
Returns:
true if this object has the same store value as the argument; false otherwise

toString

public java.lang.String toString()
Returns a string representation of the 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

Compoze Software, Inc.

Copyright ©1999-2003 Compoze Software, Inc. All rights reserved.