Compoze Software, Inc.

com.compoze.calendar
Class BusyStatus


java.lang.Object

  |

  +--com.compoze.calendar.BusyStatus

All Implemented Interfaces:
java.io.Serializable

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

This class stores the values for an appointment 'busy status'. A busy status defines the overall status for an event. The internationalizable string values are stored in the calendar_resources.properties file (accessed through CalendarProperties) and referenced by their key and can be found in calendar.jar at com.compoze.calendar.calendar_resources.properties.

See Also:
Serialized Form

Field Summary
static BusyStatus BUSY
          This value represents a 'busy' busy status.
static BusyStatus FREE
          This value represents a 'free' busy status.
static BusyStatus OUT_OF_OFFICE
          This value represents an 'out of office' busy status.
static java.util.List s_values
          An array containing all of the fixed busy status levels.
static BusyStatus TENTATIVE
          This value represents a 'tentative' busy status.
 
Method Summary
 boolean equals(java.lang.Object o)
          Checks for equality.
static BusyStatus get(int iStoreValue)
          Gets the busy status by its store value.
static BusyStatus get(java.lang.String sName)
          Gets the busy status by the name in the system default locale.
static java.util.List getList()
          Gets the list of busy status levels.
 java.lang.String getName()
          Gets the name of the busy status using the system default locale.
 java.lang.String getName(java.util.Locale locale)
          Gets the name of the busy status using the specified locale.
 int getStoreValue()
          Gets the value that's used to store the busy 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

s_values


public static java.util.List s_values
An array containing all of the fixed busy status levels.

FREE


public static final BusyStatus FREE
This value represents a 'free' busy status.

TENTATIVE


public static final BusyStatus TENTATIVE
This value represents a 'tentative' busy status.

BUSY


public static final BusyStatus BUSY
This value represents a 'busy' busy status.

OUT_OF_OFFICE


public static final BusyStatus OUT_OF_OFFICE
This value represents an 'out of office' busy status.
Method Detail

getName


public java.lang.String getName()
Gets the name of the busy status using the system default locale.
Returns:
the name

getName


public java.lang.String getName(java.util.Locale locale)
Gets the name of the busy 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 busy status in the storage system.
Returns:
the store value

get


public static BusyStatus get(int iStoreValue)
Gets the busy status by its store value.
Parameters:
iStoreValue - the store value to get by
Returns:
the matching busy status or null if not found

get


public static BusyStatus get(java.lang.String sName)
Gets the busy status by the name in the system default locale.
Parameters:
sName - the name in the system default locale
Returns:
the matching busy status or null if not found

getList


public static java.util.List getList()
Gets the list of busy status levels.
Returns:
the list of BusyStatuses (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 BusyStatus 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

Compoze Software, Inc.

Copyright ©1999-2001 Compoze Software, Inc. All rights reserved.