com.ptc.core.ui.validation
Class DefaultValidationFilter

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

All Implemented Interfaces:

ValidationFilter

Direct Known Subclasses:

DefaultUIComponentValidator

public class DefaultValidationFilter
extends Object
implements ValidationFilter

This class serves as a default implementation of the ValidationFilter Interface. Application developers should never need to modify the content of this class. Developers creating their own implementation of the ValidationFilter Interface should extend this class, as opposed to implementing the Interface directly. This default implementation of a ValidationFilter will always return results indicating that a given action/component is enabled/permitted/etc. It will never deny access/availability to an action/component. Developers who extend this class when creating their own implementation of a ValidationFilter class only need to implement the APIs where they want non-default behavior. If a given API is not defined in the subclass, the default behavior defined in this class (always enabled/permitted/etc.) will be executed.

Supported API: true

Extendable: true

Method Summary

protected UIValidationResultSet	populateResultSet(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, UIValidationStatus status) If there are targetObjects in the validationCriteria, then for each targetObject, add a result to the resultSet with the specified status If there are no targetObjects in the validation criteria, the add a single result to the resultSet with the specified status Supported API: true
UIValidationStatus	preValidateAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) Supported API: true
UIValidationStatus	preValidateAttribute(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) Supported API: true
UIValidationResultSet	preValidateMultiTargetAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) Supported API: true

Methods inherited from class java.lang.Object

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

Method Detail

preValidateAction

public UIValidationStatus preValidateAction(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                            UIValidationCriteria validationCriteria)

Supported API: true

Specified by:

preValidateAction in interface ValidationFilter

Parameters:

validationKey - A UIValidationKey object representing the action or UI component to be validated.

validationCriteria - Object holding information required to perform validation tasks.

Returns:

UIValidationStatus

See Also:

ValidationFilter.preValidateAction(com.ptc.core.ui.validation.UIValidationKey, com.ptc.core.ui.validation.UIValidationCriteria)

preValidateAttribute

public UIValidationStatus preValidateAttribute(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                               UIValidationCriteria validationCriteria)

Supported API: true

Specified by:

preValidateAttribute in interface ValidationFilter

Parameters:

validationKey - A UIValidationKey object representing the action or UI component to be validated.

validationCriteria - Object holding information required to perform validation tasks.

Returns:

UIValidationStatus

See Also:

ValidationFilter.preValidateAttribute(com.ptc.core.ui.validation.UIValidationKey, com.ptc.core.ui.validation.UIValidationCriteria)

preValidateMultiTargetAction

public UIValidationResultSet preValidateMultiTargetAction(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                                          UIValidationCriteria validationCriteria)

Supported API: true

Specified by:

preValidateMultiTargetAction in interface ValidationFilter

Parameters:

validationKey - A UIValidationKey object representing the action or UI component to be validated.

validationCriteria - Object holding information required to perform validation tasks.

Returns:

UIValidationResultSet

See Also:

ValidationFilter.preValidateMultiTargetAction(com.ptc.core.ui.validation.UIValidationKey, com.ptc.core.ui.validation.UIValidationCriteria)

populateResultSet

protected UIValidationResultSet populateResultSet(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                                  UIValidationCriteria validationCriteria,
                                                  UIValidationStatus status)

If there are targetObjects in the validationCriteria, then for each targetObject, add a result to the resultSet with the specified status If there are no targetObjects in the validation criteria, the add a single result to the resultSet with the specified status

Supported API: true

Parameters:

validationKey -

validationCriteria -

status -

Returns:

UIValidationResultSet