com.ptc.core.ui.validation
Class PostSelectValidationHelper

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

public class PostSelectValidationHelper
extends Object

This class can be used by clients wanting to call the UI Validation Service to perform post-select validation operations.

Supported API: true

Method Summary

com.ptc.core.ui.validation.UIValidationFeedbackMsg

performPostSelectValidation(NmCommandBean commandBean, String actionName, String objectType, boolean isWizard) This method will call the UI Validation Service to validate whether or not an action selected by the user should proceed.

Methods inherited from class java.lang.Object

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

Method Detail

performPostSelectValidation

public com.ptc.core.ui.validation.UIValidationFeedbackMsg performPostSelectValidation(NmCommandBean commandBean,
                                                                                      String actionName,
                                                                                      String objectType,
                                                                                      boolean isWizard)
                                                                               throws WTException

This method will call the UI Validation Service to validate whether or not an action selected by the user should proceed.

Parameters:

commandBean - - the NmCommandBean being used in the client/JSP layer

actionName - - the action name (from *actions.xml) being executed

objectType - - the object type (from *actions.xml) of the action being executed

isWizard - - if the action launches a wizard, this should be set to true

Returns:

a UIValidationFeedbackMsg object whose messageType indicates whehter or not the action should proceed

If the messageType is ERROR, the action should not be allowed to proceed
If the messageType is SUCCESS, the action should be allowed to proceed
If the messageType is CONFIRMATION, the user should be prompted to determine whether or not to proceed

The messageText attribute of the UIValidationFeedbackMsg contains any text that should be displayed to the user in a dialog. This attribute will be "" (empty string) if there is no text to display.

Throws:

WTException -

Supported API: true