com.ibm.pim.collaboration
Enum CheckoutStatus

java.lang.Object
  extended by java.lang.Enum<CheckoutStatus>
      extended by com.ibm.pim.collaboration.CheckoutStatus
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<CheckoutStatus>

public enum CheckoutStatus
extends java.lang.Enum<CheckoutStatus>

An enum class used for specifying the status of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.

Since:
6.0.0

Enum Constant Summary
ALREADY_CHECKEDOUT
          Status representing the state when the given collaboration object, such as an item or a category, is already checked out before the checkout event, within a collaboration area.
ATTRIBUTE_LOCKED
          Status representing the state when the given collaboration object, such as an item or a category, has at least one attribute instance in a locked state, within a collaboration area.
CHECKOUT_FAILED
          Status representing the failure of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.
CHECKOUT_SUCCESSFUL
          Status representing the successful completion of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.
 
Method Summary
static CheckoutStatus valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CheckoutStatus[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

CHECKOUT_SUCCESSFUL

public static final CheckoutStatus CHECKOUT_SUCCESSFUL
Status representing the successful completion of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.


ATTRIBUTE_LOCKED

public static final CheckoutStatus ATTRIBUTE_LOCKED
Status representing the state when the given collaboration object, such as an item or a category, has at least one attribute instance in a locked state, within a collaboration area.


CHECKOUT_FAILED

public static final CheckoutStatus CHECKOUT_FAILED
Status representing the failure of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.


ALREADY_CHECKEDOUT

public static final CheckoutStatus ALREADY_CHECKEDOUT
Status representing the state when the given collaboration object, such as an item or a category, is already checked out before the checkout event, within a collaboration area.

Method Detail

values

public static final CheckoutStatus[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(CheckoutStatus c : CheckoutStatus.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static CheckoutStatus valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name