wt.vc.wip
Class WorkInProgressState

java.lang.Object
  wt.fc.EnumeratedType
      wt.vc.wip.WorkInProgressState

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class WorkInProgressState
extends EnumeratedType
implements Serializable

The valid set of work-in-progress states that a workable object can exist within.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

static WorkInProgressState	CHECKED_IN A constant that predefines a WIP state of being checked in.
static WorkInProgressState	CHECKED_OUT A constant that predefines a WIP state of being checked out.
static WorkInProgressState	CHECKED_OUT_TO_SANDBOX A constant that predefines a WIP state of being checked out to an sandbox project.
static WorkInProgressState	TERMINAL A constant that predefines a WIP state of being a terminal iteration, i.e.
static WorkInProgressState	WORKING A constant that predefines a WIP state of being in work.

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static WorkInProgressState	getWorkInProgressStateDefault() Returns the default value (instance) for the WorkInProgressState set.
static WorkInProgressState[]	getWorkInProgressStateSet() Returns a copy of the set of valid values (instances) for the WorkInProgressState class.
static WorkInProgressState	toWorkInProgressState(String internal_value) Returns the WorkInProgressState instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

equals, getAbbreviatedDisplay, getDisplay, getDisplay, getFullDisplay, getLocalizedMessage, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, hashCode, isDefaultValue, isDefaultValue, isSelectable, main, toEnumeratedType, toEnumeratedType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CHECKED_IN

public static final WorkInProgressState CHECKED_IN

A constant that predefines a WIP state of being checked in.

Supported API: true

CHECKED_OUT

public static final WorkInProgressState CHECKED_OUT

A constant that predefines a WIP state of being checked out.

Supported API: true

WORKING

public static final WorkInProgressState WORKING

A constant that predefines a WIP state of being in work.

Supported API: true

CHECKED_OUT_TO_SANDBOX

public static final WorkInProgressState CHECKED_OUT_TO_SANDBOX

A constant that predefines a WIP state of being checked out to an sandbox project.

Supported API: true

TERMINAL

public static final WorkInProgressState TERMINAL

A constant that predefines a WIP state of being a terminal iteration, i.e. one upon which no further WIP is to be allowed (similar to, but different than, a released lifecycle state).

Supported API: true

Method Detail

toWorkInProgressState

public static WorkInProgressState toWorkInProgressState(String internal_value)
                                                 throws WTInvalidParameterException

Returns the WorkInProgressState instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of WorkInProgressState.

Returns:

WorkInProgressState

Throws:

WTInvalidParameterException

getWorkInProgressStateDefault

public static WorkInProgressState getWorkInProgressStateDefault()

Returns the default value (instance) for the WorkInProgressState set.

Supported API: true

Returns:

WorkInProgressState

getWorkInProgressStateSet

public static WorkInProgressState[] getWorkInProgressStateSet()

Returns a copy of the set of valid values (instances) for the WorkInProgressState class.

Supported API: true

Returns:

WorkInProgressState[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]