Compoze Software, Inc.

com.compoze.exchange
Class SortOrder

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

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

This class stores the values for a 'sort order'. 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 SortOrder ASCENDING
          This value represents an 'ascending' sort order.
static SortOrder DESCENDING
          This value represents an 'descending' sort order.
static SortOrder NONE
          This value represents a sort order of 'none'.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static SortOrder get(int iStoreValue)
          Gets the sort order by its store value.
static java.util.List getList()
          Gets the list of sort order levels.
 java.lang.String getName()
          Gets the name of the sort order using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the sort order using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the sort order 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

NONE

public static final SortOrder NONE
This value represents a sort order of 'none'.


ASCENDING

public static final SortOrder ASCENDING
This value represents an 'ascending' sort order.


DESCENDING

public static final SortOrder DESCENDING
This value represents an 'descending' sort order.

Method Detail

getName

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

Returns:
the name

getName

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

Parameters:
locale - the locale
Returns:
the name

getStoreValue

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

Returns:
the store value

get

public static SortOrder get(int iStoreValue)
Gets the sort order by its store value.

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

getList

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

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