Compoze Software, Inc.

com.compoze.exchange
Class SelectedMailingAddress

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

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

This class stores the values for a 'selected mailing address'. 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 SelectedMailingAddress BUSINESS
          This value represents a selected mailing address of 'business'.
static SelectedMailingAddress HOME
          This value represents a selected mailing address of 'home'.
static SelectedMailingAddress NONE
          This value represents a selected mailing address of 'none'.
static SelectedMailingAddress OTHER
          This value represents a selected mailing address of 'other'.
static int STORE_VALUE_BUSINESS
          This value represents the 'business' store value.
static int STORE_VALUE_HOME
          This value represents the 'home' store value.
static int STORE_VALUE_NONE
          This value represents the 'none' store value.
static int STORE_VALUE_OTHER
          This value represents the 'other' store value.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static SelectedMailingAddress get(int iStoreValue)
          Gets the selected mailing address by its store value.
static java.util.List getList()
          Gets the list of selected mailing addresses.
 java.lang.String getName()
          Gets the name of the selected mailing address using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the selected mailing address using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the selected mailing address 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_HOME

public static final int STORE_VALUE_HOME
This value represents the 'home' store value.

See Also:
Constant Field Values

STORE_VALUE_BUSINESS

public static final int STORE_VALUE_BUSINESS
This value represents the 'business' store value.

See Also:
Constant Field Values

STORE_VALUE_OTHER

public static final int STORE_VALUE_OTHER
This value represents the 'other' store value.

See Also:
Constant Field Values

NONE

public static final SelectedMailingAddress NONE
This value represents a selected mailing address of 'none'.


HOME

public static final SelectedMailingAddress HOME
This value represents a selected mailing address of 'home'.


BUSINESS

public static final SelectedMailingAddress BUSINESS
This value represents a selected mailing address of 'business'.


OTHER

public static final SelectedMailingAddress OTHER
This value represents a selected mailing address of 'other'.

Method Detail

getName

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

Returns:
the name

getName

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

Parameters:
locale - the locale
Returns:
the name

getStoreValue

public int getStoreValue()
Gets the value that's used to store the selected mailing address 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 SelectedMailingAddress get(int iStoreValue)
Gets the selected mailing address by its store value.

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

getList

public static java.util.List getList()
Gets the list of selected mailing addresses.

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