com.ptc.core.ui.validation
Interface ValidationFilter

All Known Subinterfaces:

UIComponentValidator

All Known Implementing Classes:

AttachmentsEditActionValidator, ChangeMgmtCreateWizardsValidator, com.ptc.core.components.validators.DefaultCreateValidator, DefaultUIComponentValidator, DefaultValidationFilter, DocFromTemplateCreateValidator, RelatedChangesValidator, RevisionLabelValidator, ShareStatusValidator, WorkSetCreateWizardsValidator

public interface ValidationFilter

A UIVFilter is a delegate that the UI validation service calls before calling any validators.

In other words, suppose that a certain check should be performed on multiple actions. Rather than adding logic to each of those actions' validators, you could create a UIVFilter implementation to perform the check and short-circuit the call to the validators.

This approach is intended to save both performance and coding effort.


Supported API: true

Extendable: false

Method Summary

UIValidationStatus	preValidateAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) This method will be invoked by a client who wants to verify whether or not an action should appear to the user in the UI Supported API: true
UIValidationStatus	preValidateAttribute(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) This method will be invoked by a client who wants to verify whether or not an attribute should appear to the user in the UI Supported API: true
UIValidationResultSet	preValidateMultiTargetAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria) This method will be invoked by a client who wants to verify whether or not an action(validated against multiple target objects) should appear to the user in the UI Supported API: true

Method Detail

preValidateAction

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

This method will be invoked by a client who wants to verify whether or not an action should appear to the user in the UI

Supported API: true

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

preValidateAttribute

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

This method will be invoked by a client who wants to verify whether or not an attribute should appear to the user in the UI

Supported API: true

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

preValidateMultiTargetAction

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

This method will be invoked by a client who wants to verify whether or not an action(validated against multiple target objects) should appear to the user in the UI

Supported API: true

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