Compoze Software, Inc.

com.compoze.exchange
Class Sensitivity

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

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

This class stores the values for 'sensitivity'. 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 Sensitivity CONFIDENTIAL
          This value represents a sensitivity of 'confidential'.
static Sensitivity NONE
          This value represents a sensitivity of 'none'.
static Sensitivity PERSONAL
          This value represents a sensitivity of 'personal'.
static Sensitivity PRIVATE
          This value represents a sensitivity of 'private'.
static int STORE_VALUE_CONFIDENTIAL
          This value represents the 'confidential' store value.
static int STORE_VALUE_NONE
          This value represents the 'none' store value.
static int STORE_VALUE_PERSONAL
          This value represents the 'personal' store value.
static int STORE_VALUE_PRIVATE
          This value represents the 'private' store value.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static Sensitivity get(int iStoreValue)
          Gets the sensitivity by its store value.
static java.util.List getList()
          Gets the list of sensitivity levels.
 java.lang.String getName()
          Gets the name of the sensitivity using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the sensitivity using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the sensitivity in the storage system.
 java.lang.Object getStoreValueObject()
          Gets the store value as an object.
 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_NONE

public static final int STORE_VALUE_NONE
This value represents the 'none' store value.

See Also:
Constant Field Values

STORE_VALUE_PERSONAL

public static final int STORE_VALUE_PERSONAL
This value represents the 'personal' store value.

See Also:
Constant Field Values

STORE_VALUE_PRIVATE

public static final int STORE_VALUE_PRIVATE
This value represents the 'private' store value.

See Also:
Constant Field Values

STORE_VALUE_CONFIDENTIAL

public static final int STORE_VALUE_CONFIDENTIAL
This value represents the 'confidential' store value.

See Also:
Constant Field Values

NONE

public static final Sensitivity NONE
This value represents a sensitivity of 'none'.


PERSONAL

public static final Sensitivity PERSONAL
This value represents a sensitivity of 'personal'.


PRIVATE

public static final Sensitivity PRIVATE
This value represents a sensitivity of 'private'.


CONFIDENTIAL

public static final Sensitivity CONFIDENTIAL
This value represents a sensitivity of 'confidential'.

Method Detail

getName

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

Returns:
the name

getName

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

Parameters:
locale - the locale
Returns:
the name

getStoreValue

public int getStoreValue()
Gets the value that's used to store the sensitivity 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

get

public static Sensitivity get(int iStoreValue)
Gets the sensitivity by its store value.

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

getList

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

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