com.ptc.core.ui.validation
Class UIValidationResult

java.lang.Object
  com.ptc.core.ui.validation.UIValidationResult

All Implemented Interfaces:

Serializable

public class UIValidationResult
extends Object
implements Serializable

A UIValidationResult object contains one unit of validation output (one action/component, one object). It should always contain at least a validationKey attribute, indicating the key that was used to perform the validation, and a status attribute, indicating what should be done with the selected action/component (e.g., display the action/component, hide the action/component, allow the selected action to proceed, etc.) In addition, a UIValidationResult may also contain a targetObject attribute, which links the result to a specific WTReference, and a feedbackMsg attribute, which contains text that could optionally be displayed to the user.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

static UIValidationResult	newInstance() Creates an empty UIValidationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status) Creates a UIValdiationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status, List<UIValidationFeedbackMsg> feedbackMsgList) Creates a UIValdiationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status, UIValidationFeedbackMsg feedbackMsg) Creates a UIValdiationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status, WTReference targetObject) Creates a UIValdiationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status, WTReference targetObject, List<UIValidationFeedbackMsg> feedbackMsgList) Creates a UIValdiationResult object Supported API: true
static UIValidationResult	newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationStatus status, WTReference targetObject, UIValidationFeedbackMsg feedbackMsg) Creates a UIValdiationResult object Supported API: true

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

newInstance

public static UIValidationResult newInstance()

Creates an empty UIValidationResult object

Supported API: true

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The UIValidationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status,
                                             List<UIValidationFeedbackMsg> feedbackMsgList)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The validationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

feedbackMsgList - A List of UIValidationFeedbackMsg objects providing additional feedback for the end user

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status,
                                             UIValidationFeedbackMsg feedbackMsg)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The UIValidationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

feedbackMsg - A single UIValidationFeedbackMsg to associate with the result

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status,
                                             WTReference targetObject)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The UIValidationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

targetObject - The object that this UIValidationResult applies to

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status,
                                             WTReference targetObject,
                                             List<UIValidationFeedbackMsg> feedbackMsgList)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The validationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

targetObject - The object that this UIValidationResult applies to

feedbackMsgList - A List of UIValidationFeedbackMsg objects providing additional feedback for the end user

newInstance

public static UIValidationResult newInstance(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                             UIValidationStatus status,
                                             WTReference targetObject,
                                             UIValidationFeedbackMsg feedbackMsg)

Creates a UIValdiationResult object

Supported API: true

Parameters:

validationKey - The UIValidationKey that was used to perform validation

status - a UIValidationStatus enumerated type indicating what should be done for the given action/component

targetObject - The object that this UIValidationResult applies to

feedbackMsg - A single UIValidationFeedbackMsg to associate with the result