Compoze Software, Inc.

com.compoze.exchange
Class BusyStatus


java.lang.Object

  |

  +--com.compoze.exchange.BusyStatus

All Implemented Interfaces:
java.io.Serializable

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

This class stores the values for a 'busy 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 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 int STORE_VALUE_BUSY
          This value represents the 'busy' store value.
static int STORE_VALUE_FREE
          This value represents the 'free' store value.
static int STORE_VALUE_OUT_OF_OFFICE
          This value represents the 'out of office' store value.
static int STORE_VALUE_TENTATIVE
          This value represents the 'tentative' store value.
static java.lang.String STRING_STORE_VALUE_BUSY
          This value represents the 'busy' store value.
static java.lang.String STRING_STORE_VALUE_FREE
          This value represents the 'free' store value.
static java.lang.String STRING_STORE_VALUE_OUT_OF_OFFICE
          This value represents the 'out of office' store value.
static java.lang.String STRING_STORE_VALUE_TENTATIVE
          This value represents the 'tentative' store value.
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 sStoreValue)
          Gets the importance by the store value.
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.Object getStoreValueObject()
          Gets the store value as an object.
 java.lang.String getStoreValueString()
          Gets the store value as a string.
 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_FREE


public static final int STORE_VALUE_FREE
This value represents the 'free' store value.

STORE_VALUE_TENTATIVE


public static final int STORE_VALUE_TENTATIVE
This value represents the 'tentative' store value.

STORE_VALUE_BUSY


public static final int STORE_VALUE_BUSY
This value represents the 'busy' store value.

STORE_VALUE_OUT_OF_OFFICE


public static final int STORE_VALUE_OUT_OF_OFFICE
This value represents the 'out of office' store value.

STRING_STORE_VALUE_FREE


public static final java.lang.String STRING_STORE_VALUE_FREE
This value represents the 'free' store value.

NOTE: This method is for internal use only within the WebDAV API.


STRING_STORE_VALUE_TENTATIVE


public static final java.lang.String STRING_STORE_VALUE_TENTATIVE
This value represents the 'tentative' store value.

NOTE: This method is for internal use only within the WebDAV API.


STRING_STORE_VALUE_BUSY


public static final java.lang.String STRING_STORE_VALUE_BUSY
This value represents the 'busy' store value.

NOTE: This method is for internal use only within the WebDAV API.


STRING_STORE_VALUE_OUT_OF_OFFICE


public static final java.lang.String STRING_STORE_VALUE_OUT_OF_OFFICE
This value represents the 'out of office' store value.

NOTE: This method is for internal use only within the WebDAV API.


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

getStoreValueObject


public java.lang.Object getStoreValueObject()
Gets the store value as an object.
Returns:
the store value

getStoreValueString


public java.lang.String getStoreValueString()
Gets the store value as a string.

This method returns the string value of the BusyStatus object that is stored in the Exchange store in the WebDAV property urn:schemas:calendar:busystatus.

NOTE: This method is for internal use only within the WebDAV API.

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 sStoreValue)
Gets the importance by the store value.

NOTE: This method is for internal use only within the WebDAV API.

Parameters:
sStoreValue - the store value to get by
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
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-2003 Compoze Software, Inc. All rights reserved.