Compoze Software, Inc.

com.compoze.exchange
Class RecipientType

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

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

This class stores the values for a 'recipient type'. 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 RecipientType BCC
          This value represents a 'bcc' recipient type.
static RecipientType CC
          This value represents a 'cc' recipient type.
static RecipientType TO
          This value represents a 'to' recipient type.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static RecipientType get(int iStoreValue)
          Gets the recipient type by its store value.
static java.util.List getList()
          Gets the list of recipient types.
 java.lang.String getName()
          Gets the name of the recipient type using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the recipient type using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the recipient type in the storage system.
 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

TO

public static final RecipientType TO
This value represents a 'to' recipient type.


CC

public static final RecipientType CC
This value represents a 'cc' recipient type.


BCC

public static final RecipientType BCC
This value represents a 'bcc' recipient type.

Method Detail

getName

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

Returns:
the name

getName

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

Parameters:
locale - the locale
Returns:
the name

getStoreValue

public int getStoreValue()
Gets the value that's used to store the recipient type in the storage system.

Returns:
the store value

get

public static RecipientType get(int iStoreValue)
Gets the recipient type by its store value.

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

getList

public static java.util.List getList()
Gets the list of recipient types.

Returns:
the list of RecipientTypes (unmodifiable)

equals

public boolean equals(java.lang.Object o)
Checks for equality. The store value is used to determine equality, so that the language the name is represented in is not important.

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.