com.ptc.core.ui.validation
Interface UIComponentValidator

All Superinterfaces:

ValidationFilter

All Known Implementing Classes:

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

public interface UIComponentValidator
extends ValidationFilter

This Interface defines the APIs that all delegates used by the UIComponentValidationService need to implement. It is recommended that application developers not implement this Interface directly, but rather extend the default implementation of this interface - DefaultUIComponentValidator.

Supported API: true

Extendable: false

Method Summary

UIValidationResultSet	performFullPreValidation(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, Locale locale) This method will be invoked by a client wanting to get an accurate indication of whether or not an action or component should be enabled, disabled, or hidden in the UI.
UIValidationResultSet	performLimitedPreValidation(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, Locale locale) This method will be invoked by a client wanting to get a quick indication of whether or not an action or component should be enabled, disabled, or hidden in the UI.
UIValidationResult	validateFormSubmission(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, Locale locale) This method will be invoked by a client wanting to perform some server-side validation when a user tries to submit a form (e.g., a single wizard step, or an entire wizard).
UIValidationResult	validateSelectedAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, Locale locale) This method will be invoked by a client who wants to verify whether or not an action that the user is trying to perform should be allowed to proceed.
UIValidationResultSet	validateSelectedMultiSelectAction(com.ptc.core.ui.validation.UIValidationKey validationKey, UIValidationCriteria validationCriteria, Locale locale) This method will be invoked by a client who wants to verify whether or not an action that the user is trying to perform should be allowed to proceed.

Methods inherited from interface com.ptc.core.ui.validation.ValidationFilter

preValidateAction, preValidateAttribute, preValidateMultiTargetAction

Method Detail

performFullPreValidation

UIValidationResultSet performFullPreValidation(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                               UIValidationCriteria validationCriteria,
                                               Locale locale)
                                               throws WTException

This method will be invoked by a client wanting to get an accurate indication of whether or not an action or component should be enabled, disabled, or hidden in the UI. Developers creating their own implementations of this method should make sure that they are providing results that are as accurate as possible, regardless of costly server-side calculations. A client wanting faster performance (with the trade-off of potentially less-accurate results) should call performLimitedPreValidation.

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.

locale - The user's Locale. If a null value is passed in, the session locale will be used.

Returns:

UIValidationResultSet

Throws:

WTException

performLimitedPreValidation

UIValidationResultSet performLimitedPreValidation(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                                  UIValidationCriteria validationCriteria,
                                                  Locale locale)
                                                  throws WTException

This method will be invoked by a client wanting to get a quick indication of whether or not an action or component should be enabled, disabled, or hidden in the UI. Developers creating their own implementations of this method should make sure that they are only using inexpensive checks to provide results from this method, even if it means they are not guaranteed to be accurate. A client wanting better accuracy (with the trade-off of slower performance) should call the performGetFullPreValidation method.

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.

locale - The user's Locale. If a null value is passed in, the session locale will be used.

Returns:

UIValidationResultSet

Throws:

WTException

validateFormSubmission

UIValidationResult validateFormSubmission(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                          UIValidationCriteria validationCriteria,
                                          Locale locale)
                                          throws WTException

This method will be invoked by a client wanting to perform some server-side validation when a user tries to submit a form (e.g., a single wizard step, or an entire wizard).

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.

locale - The user's Locale. If a null value is passed in, the session locale will be used.

Returns:

UIValidationResult

Throws:

WTException

validateSelectedAction

UIValidationResult validateSelectedAction(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                          UIValidationCriteria validationCriteria,
                                          Locale locale)
                                          throws WTException

This method will be invoked by a client who wants to verify whether or not an action that the user is trying to perform should be allowed to proceed. This method should be called for single-select actions (e.g., an action from a dropdown list). If the selected action could potentailly be performed on multiple objects (e.g., a table selection action in a table header), the validateSelectedMultiSelectAction method should be invoked instead.

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.

locale - The user's Locale. If a null value is passed in, the session locale will be used.

Returns:

UIValidationResult

Throws:

WTException

validateSelectedMultiSelectAction

UIValidationResultSet validateSelectedMultiSelectAction(com.ptc.core.ui.validation.UIValidationKey validationKey,
                                                        UIValidationCriteria validationCriteria,
                                                        Locale locale)
                                                        throws WTException

This method will be invoked by a client who wants to verify whether or not an action that the user is trying to perform should be allowed to proceed. This method should be called for multi-select actions (e.g., a table selection action in a table header), or in cases where the selected action could potentailly be performed on multiple objects. If the selected action will always be performed on a single object (e.g., an action from a dropdown list), the validateSelectedAction method should be invoked instead.

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.

locale - The user's Locale. If a null value is passed in, the session locale will be used.

Returns:

UIValidationResultSet

Throws:

WTException