Package com.ptc.core.ui.validation

Class UIValidationStatus

java.lang.Object

wt.fc.EnumeratedType

com.ptc.core.ui.validation.UIValidationStatus

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class UIValidationStatus
extends EnumeratedType
implements Serializable

This EnumeratedType sub-class contains a set of statuses that can be used to indicate an action's or a component's availability/visibility/permission in the UI.

Supported API: true

Extendable: false

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class wt.fc.EnumeratedType

EnumeratedType.OrderOnOrder

Field Summary

Fields

Modifier and Type	Field	Description
static final UIValidationStatus	ATTR_HIDDEN	This status should be used to indicate that an attribute's name and value should be hidden to to a user in the UI.
static final UIValidationStatus	ATTR_HIDDEN_VALUE	This status should be used to indicate that an attribute's value (but not its name) should be hidden to to a user in the UI.
static final UIValidationStatus	DENIED	This status should be used to indicate that a user is not allowed to perform an action they have tried to execute in the UI.
static final UIValidationStatus	DISABLED	This status should be used to indicate that a given action or component is visible in the UI, but can not be edited or selected.
static final UIValidationStatus	ENABLED	This status should be used to indicate that a given action or component is visible in the UI, and can be edited or selected.
static final UIValidationStatus	HIDDEN	This status should be used to indicate that a given action or component is not visible in the UI, and thereforecan not be edited or selected.
static final UIValidationStatus	NOT_VALIDATED	This status should be used to indicate that a component (action or attribute) has not been subjected to any validation.
static final UIValidationStatus	PERMITTED	This status should be used to indicate that a user is allowed to perform an action they have tried to execute in the UI.
static final UIValidationStatus	PROMPT_FOR_CONFIRMATION	This status should be used to indicate that a user needs to decide via a confirmation prompt whether or not they want to proceed with an action based on some feedback from the validation service Supported API: true

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR, userLocale

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

Modifier and Type	Method	Description
static UIValidationStatus	getUIValidationStatusDefault()	Returns the default value (instance) for the UIValidationStatus set.
static UIValidationStatus[]	getUIValidationStatusSet()	Returns a copy of the set of valid values (instances) for the UIValidationStatus class.
EnumeratedType[]	getValueSet()	Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static UIValidationStatus	toUIValidationStatus(String internal_value)	Returns the UIValidationStatus instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

clearCustomEnumsCache, compareTo, defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getShortDescription, getStringValue, getStringValue, getValidSet, getValue, hashCode, instantiateSet, instantiateSet, isCustomValueLoaded, isDefaultValue, isDefaultValue, isPrimaryKey, isSelectable, main, readResolve, setCustomValueLoaded, setCustomValueLoadedTrueForAllEntries, setDefaultValue, setLocalizedValues, setOrder, setSelectable, setValue, toEnumeratedType, toEnumeratedType, toEnumeratedType, toString, validateFriendship

Methods inherited from class java.lang.Object

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

Field Details

DENIED

public static final UIValidationStatus DENIED

This status should be used to indicate that a user is not allowed to perform an action they have tried to execute in the UI.

Supported API: true

DISABLED

public static final UIValidationStatus DISABLED

This status should be used to indicate that a given action or component is visible in the UI, but can not be edited or selected.

Supported API: true

ENABLED

public static final UIValidationStatus ENABLED

This status should be used to indicate that a given action or component is visible in the UI, and can be edited or selected.

Supported API: true

HIDDEN

public static final UIValidationStatus HIDDEN

This status should be used to indicate that a given action or component is not visible in the UI, and thereforecan not be edited or selected.

Supported API: true

PERMITTED

public static final UIValidationStatus PERMITTED

This status should be used to indicate that a user is allowed to perform an action they have tried to execute in the UI.

Supported API: true

PROMPT_FOR_CONFIRMATION

public static final UIValidationStatus PROMPT_FOR_CONFIRMATION

This status should be used to indicate that a user needs to decide via a confirmation prompt whether or not they want to proceed with an action based on some feedback from the validation service

Supported API: true

ATTR_HIDDEN

public static final UIValidationStatus ATTR_HIDDEN

This status should be used to indicate that an attribute's name and value should be hidden to to a user in the UI.

Supported API: true

ATTR_HIDDEN_VALUE

public static final UIValidationStatus ATTR_HIDDEN_VALUE

This status should be used to indicate that an attribute's value (but not its name) should be hidden to to a user in the UI.

Supported API: true

NOT_VALIDATED

public static final UIValidationStatus NOT_VALIDATED

This status should be used to indicate that a component (action or attribute) has not been subjected to any validation.

Supported API: true

Method Details

toUIValidationStatus

public static UIValidationStatus toUIValidationStatus(String internal_value)
                                               throws WTInvalidParameterException

Returns the UIValidationStatus instance for the internal_value argument.

Supported API: true

Parameters:

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

Returns:

UIValidationStatus

Throws:

WTInvalidParameterException

getUIValidationStatusDefault

public static UIValidationStatus getUIValidationStatusDefault()

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

Supported API: true

Returns:

UIValidationStatus

getUIValidationStatusSet

public static UIValidationStatus[] getUIValidationStatusSet()

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

Supported API: true

Returns:

UIValidationStatus[]

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