wt.vc.wip
Class WorkInProgressState

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

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

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

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

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.
private static String	CLASS_RESOURCE
private static String	CLASSNAME
private static Hashtable	localeSets
private static String	RESOURCE
static WorkInProgressState	TERMINAL A constant that predefines a WIP state of being a terminal iteration, i.e.
static WorkInProgressState	TO_CHECKED_IN A constant that predefines a WIP transition state of going from a checkout to a checkin.
static WorkInProgressState	TO_DELETED A constant that predefines a WIP transition state of going from a checkout to being deleted.
protected static WorkInProgressState	TO_WORKING A constant that predefines a WIP transition state of going from a checkin to working.
private static EnumeratedType[]	valueSet
static WorkInProgressState	WORKING A constant that predefines a WIP state of being in work.

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Constructor Summary

protected

WorkInProgressState() Used by sub-classes that need a default constructor.

Method Summary

protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
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.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static WorkInProgressState	newWorkInProgressState(int secretHandshake) Used by EnumeratedType for constructing instances of WorkInProgressState, from a resource bundle.
static WorkInProgressState	toWorkInProgressState(String internal_value) Returns the WorkInProgressState instance for the internal_value argument.
protected EnumeratedType[]	valueSet() Returns a reference to the set of valid values (instances) for this instance.

Methods inherited from class wt.fc.EnumeratedType

defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getShortDescription, getStringValue, getStringValue, getValidSet, getValue, hashCode, instantiateSet, isDefaultValue, isDefaultValue, isPrimaryKey, isSelectable, main, readResolve, toEnumeratedType, toEnumeratedType, toEnumeratedType, toString, validateFriendship

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASS_RESOURCE

private static final String CLASS_RESOURCE

See Also:

Constant Field Values

valueSet

private static final EnumeratedType[] valueSet

localeSets

private static Hashtable localeSets

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

TO_CHECKED_IN

public static final WorkInProgressState TO_CHECKED_IN

A constant that predefines a WIP transition state of going from a checkout to a checkin.

Supported API: false

TO_DELETED

public static final WorkInProgressState TO_DELETED

A constant that predefines a WIP transition state of going from a checkout to being deleted. This only applies to the working copy of the original checked out copy.

Supported API: false

TO_WORKING

protected static final WorkInProgressState TO_WORKING

A constant that predefines a WIP transition state of going from a checkin to working. This transitional state is only applicable to an object being checked out and thus is not externally visible.

Supported API: false

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

Constructor Detail

WorkInProgressState

protected WorkInProgressState()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newWorkInProgressState

public static WorkInProgressState newWorkInProgressState(int secretHandshake)
                                                  throws IllegalAccessException

Used by EnumeratedType for constructing instances of WorkInProgressState, from a resource bundle.

Supported API: false

Parameters:

secretHandshake -

Returns:

WorkInProgressState

Throws:

IllegalAccessException

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[]

valueSet

protected EnumeratedType[] valueSet()

Returns a reference to the set of valid values (instances) for this instance.

Supported API: false

Specified by:

valueSet in class EnumeratedType

Returns:

EnumeratedType[]

getLocaleSet

protected EnumeratedType[] getLocaleSet(Locale locale)

Returns the set of values (instances) for this instance, for the specified locale.

Supported API: false

Specified by:

getLocaleSet in class EnumeratedType

Parameters:

locale -

Returns:

EnumeratedType[]

initializeLocaleSet

private static EnumeratedType[] initializeLocaleSet(Locale locale)
                                             throws Throwable

Parameters:

locale -

Returns:

EnumeratedType[]

Throws:

Throwable