com.compoze.exchange
Class RecurrenceInstance

java.lang.Object

  |

  +--com.compoze.exchange.RecurrenceInstance

All Implemented Interfaces:

java.io.Serializable

public class RecurrenceInstance

extends java.lang.Object

implements java.io.Serializable

This class stores the values for a 'recurrence instance'. 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 RecurrenceInstance	FIRST This value represents a 'first' recurrence instance.
static RecurrenceInstance	FOURTH This value represents a 'fourth' recurrence instance.
static RecurrenceInstance	LAST This value represents a 'last' recurrence instance.
static RecurrenceInstance	SECOND This value represents a 'second' recurrence instance.
static int	STORE_VALUE_FIRST This represents the 'first' store value.
static int	STORE_VALUE_FOURTH This represents the 'fourth' store value.
static int	STORE_VALUE_LAST This represents the 'last' store value.
static int	STORE_VALUE_SECOND This represents the 'second' store value.
static int	STORE_VALUE_THIRD This represents the 'third' store value.
static RecurrenceInstance	THIRD This value represents a 'third' recurrence instance.

Method Summary

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

public static final int STORE_VALUE_FIRST

This represents the 'first' store value.

STORE_VALUE_SECOND

public static final int STORE_VALUE_SECOND

This represents the 'second' store value.

STORE_VALUE_THIRD

public static final int STORE_VALUE_THIRD

This represents the 'third' store value.

STORE_VALUE_FOURTH

public static final int STORE_VALUE_FOURTH

This represents the 'fourth' store value.

STORE_VALUE_LAST

public static final int STORE_VALUE_LAST

This represents the 'last' store value.

FIRST

public static final RecurrenceInstance FIRST

This value represents a 'first' recurrence instance.

SECOND

public static final RecurrenceInstance SECOND

This value represents a 'second' recurrence instance.

THIRD

public static final RecurrenceInstance THIRD

This value represents a 'third' recurrence instance.

FOURTH

public static final RecurrenceInstance FOURTH

This value represents a 'fourth' recurrence instance.

LAST

public static final RecurrenceInstance LAST

This value represents a 'last' recurrence instance.

Method Detail

getName

public java.lang.String getName()

Gets the name of the recurrence instance using the system default locale.

Returns:

the name

getName

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

Gets the name of the recurrence instance using the specified locale.

Parameters:

locale - the locale

Returns:

the name

getStoreValue

public int getStoreValue()

Gets the value that's used to store the recurrence instance in the storage system.

Returns:

the store value

get

public static RecurrenceInstance get(int iStoreValue)

Gets the recurrence instance by its store value.

Parameters:

iStoreValue - the store value to get by

Returns:

the matching recurrence instance or null if not found

getList

public static java.util.List getList()

Gets the list of recurrence instance levels.

Returns:

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

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