com.compoze.exchange
Class TaskResponseStatus

java.lang.Object

  |

  +--com.compoze.exchange.TaskResponseStatus

All Implemented Interfaces:

java.io.Serializable

public class TaskResponseStatus

extends java.lang.Object

implements java.io.Serializable

This class stores the values for a 'task response status'. 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 TaskResponseStatus	ACCEPTED This value represents a response status of 'accepted'.
static TaskResponseStatus	DECLINED This value represents a response status of 'declinde'.
static TaskResponseStatus	NONE This value represents a response status of 'none'.
static int	STORE_VALUE_ACCEPTED This value represents the 'accepted' store value.
static int	STORE_VALUE_DECLINED This value represents the 'declined' store value.
static int	STORE_VALUE_NONE This value represents the 'none' store value.

Method Summary

boolean	equals(java.lang.Object o) Checks for equality.
static TaskResponseStatus	get(int iStoreValue) Gets the task response status by its store value.
static java.util.List	getList() Gets the list of response status levels.
java.lang.String	getName() Gets the name of the response status using the system default locale.
java.lang.String	getName(java.util.Locale locale) Gets the name of the response status using the specified locale.
int	getStoreValue() Gets the value that's used to store the response status 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_NONE

public static final int STORE_VALUE_NONE

This value represents the 'none' store value.

STORE_VALUE_ACCEPTED

public static final int STORE_VALUE_ACCEPTED

This value represents the 'accepted' store value.

STORE_VALUE_DECLINED

public static final int STORE_VALUE_DECLINED

This value represents the 'declined' store value.

NONE

public static final TaskResponseStatus NONE

This value represents a response status of 'none'.

ACCEPTED

public static final TaskResponseStatus ACCEPTED

This value represents a response status of 'accepted'.

DECLINED

public static final TaskResponseStatus DECLINED

This value represents a response status of 'declinde'.

Method Detail

getName

public java.lang.String getName()

Gets the name of the response status using the system default locale.

Returns:

the name

getName

public java.lang.String getName(java.util.Locale locale)

Gets the name of the response status using the specified locale.

Parameters:

locale - the locale

Returns:

the name

getStoreValue

public int getStoreValue()

Gets the value that's used to store the response status in the storage system.

Returns:

the store value

get

public static TaskResponseStatus get(int iStoreValue)

Gets the task response status by its store value.

Parameters:

iStoreValue - the store value to get by

Returns:

the matching task response status or null if not found

getList

public static java.util.List getList()

Gets the list of response status levels.

Returns:

the list of TaskResponseStatuses (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.

Overrides:

equals in class java.lang.Object

Parameters:

o - the object to check (must be an TaskResponseStatus or else a ClassCastException is thrown)

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.

Overrides:

toString in class java.lang.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