Compoze Software, Inc.

com.compoze.domino
Class RecipientType

java.lang.Object
  extended bycom.compoze.domino.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 domino_resources.properties file (accessed through DominoProperties) 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 RESOURCE
          This value represents a 'resource' recipient type.
static RecipientType ROOM
          This value represents a 'room' recipient type.
static int STORE_VALUE_BCC
          This store value represents 'bcc'.
static int STORE_VALUE_CC
          This store value represents 'cc'.
static int STORE_VALUE_RESOURCE
          This store value represents 'resource'.
static int STORE_VALUE_ROOM
          This store value represents 'room'.
static int STORE_VALUE_TO
          This store value represents 'to'.
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

STORE_VALUE_TO

public static final int STORE_VALUE_TO
This store value represents 'to'.

See Also:
Constant Field Values

STORE_VALUE_CC

public static final int STORE_VALUE_CC
This store value represents 'cc'.

See Also:
Constant Field Values

STORE_VALUE_BCC

public static final int STORE_VALUE_BCC
This store value represents 'bcc'.

See Also:
Constant Field Values

STORE_VALUE_ROOM

public static final int STORE_VALUE_ROOM
This store value represents 'room'.

See Also:
Constant Field Values

STORE_VALUE_RESOURCE

public static final int STORE_VALUE_RESOURCE
This store value represents 'resource'.

See Also:
Constant Field Values

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.


ROOM

public static final RecipientType ROOM
This value represents a 'room' recipient type.


RESOURCE

public static final RecipientType RESOURCE
This value represents a 'resource' 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.