Compoze Software, Inc.

com.compoze.exchange
Class DisplayType

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

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

This class stores the values for a 'display 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 DisplayType AGENT
          This value represents the 'agent' display type.
static DisplayType DIST_LIST
          This value represents the 'distribution list' display type.
static DisplayType FORUM
          This value represents the 'forum' display type.
static DisplayType ORGANIZATION
          This value represents the 'organization' display type.
static DisplayType PRIVATE_DIST_LIST
          This value represents the 'private dist list' display type.
static DisplayType REMOTE_USER
          This value represents the 'remote user' display type.
static int STORE_VALUE_AGENT
          This value represents the 'agent' store value.
static int STORE_VALUE_DIST_LIST
          This value represents the 'distribution list' store value.
static int STORE_VALUE_FORUM
          This value represents the 'forum' store value.
static int STORE_VALUE_ORGANIZATION
          This value represents the 'organization' store value.
static int STORE_VALUE_PRIVATE_DIST_LIST
          This value represents the 'private dist list' store value.
static int STORE_VALUE_PRIVATE_REMOTE_USER
          This value represents the 'remote user' store value.
static int STORE_VALUE_USER
          This value represents the 'user' store value.
static DisplayType USER
          This value represents the 'user' display type.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static DisplayType get(int iStoreValue)
          Gets the display type by its store value.
static java.util.List getList()
          Gets the list of display type levels.
 java.lang.String getName()
          Gets the name of the display type using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the display type using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the display 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_USER

public static final int STORE_VALUE_USER
This value represents the 'user' store value.

See Also:
Constant Field Values

STORE_VALUE_DIST_LIST

public static final int STORE_VALUE_DIST_LIST
This value represents the 'distribution list' store value.

See Also:
Constant Field Values

STORE_VALUE_FORUM

public static final int STORE_VALUE_FORUM
This value represents the 'forum' store value.

See Also:
Constant Field Values

STORE_VALUE_AGENT

public static final int STORE_VALUE_AGENT
This value represents the 'agent' store value.

See Also:
Constant Field Values

STORE_VALUE_ORGANIZATION

public static final int STORE_VALUE_ORGANIZATION
This value represents the 'organization' store value.

See Also:
Constant Field Values

STORE_VALUE_PRIVATE_DIST_LIST

public static final int STORE_VALUE_PRIVATE_DIST_LIST
This value represents the 'private dist list' store value.

See Also:
Constant Field Values

STORE_VALUE_PRIVATE_REMOTE_USER

public static final int STORE_VALUE_PRIVATE_REMOTE_USER
This value represents the 'remote user' store value.

See Also:
Constant Field Values

USER

public static final DisplayType USER
This value represents the 'user' display type.


DIST_LIST

public static final DisplayType DIST_LIST
This value represents the 'distribution list' display type.


FORUM

public static final DisplayType FORUM
This value represents the 'forum' display type.


AGENT

public static final DisplayType AGENT
This value represents the 'agent' display type.


ORGANIZATION

public static final DisplayType ORGANIZATION
This value represents the 'organization' display type.


PRIVATE_DIST_LIST

public static final DisplayType PRIVATE_DIST_LIST
This value represents the 'private dist list' display type.


REMOTE_USER

public static final DisplayType REMOTE_USER
This value represents the 'remote user' display type.

Method Detail

getName

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

Returns:
the name

getName

public java.lang.String getName(java.util.Locale locale)
Gets the name of the display 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 display type in the storage system.

Returns:
the store value

get

public static DisplayType get(int iStoreValue)
Gets the display type by its store value.

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

getList

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

Returns:
the list of DisplayTypees (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.