lumis.doui.control.validator
Class RequiredValueValidatorControl

java.lang.Object
  lumis.doui.control.Control
      lumis.doui.control.ValidatorControl
          lumis.doui.control.validator.RequiredValueValidatorControl

All Implemented Interfaces:

VariableResolver, IControl, IValidatorControl

Direct Known Subclasses:

FriendlyIdValidationControl, RequiredValueWhenEnableControl, RequiredValueWhenVisibleValidatorControl, RestShortNameValidationControl

public class RequiredValueValidatorControl
extends ValidatorControl

Generates client side and server side validation that verifies that a control has a value that is not null.

Example use:

<control:lum_requiredValueValidator/> xml data available for xsl rendering: <control id="8A488A03115169250111519F7AF1025D" type="lum_requiredValueValidator"> <script>function Validate_Form_8A488A03115169250111519610B501B6_8A488A03115169250111519F7AF1025D() {var clientValue = LumisDouiGetValues('lumis.doui.control.inputtext.InputTextControl','Form_8A488A03115169250111519610B501B6','name');if (clientValue == null) {LumisDouiValidatorSetMessages("Form_8A488A03115169250111519610B501B68A488A03115169250111519F7AF1025D","<img src=\"lumis/portal/client/images/FieldFailedValidation.gif\"></img>","STR_CONTROL_BEING_VALIDATED_IS_NOT_CLIENT_SIDE_READABLE");LumisDouiErrorSummaryAddMessage('Form_8A488A03115169250111519610B501B6_lum_errorSummary',"STR_CONTROL_BEING_VALIDATED_IS_NOT_CLIENT_SIDE_READABLE"); return false;} else if (clientValue.length == 0 || clientValue[0] == '') { LumisDouiValidatorSetMessages("Form_8A488A03115169250111519610B501B68A488A03115169250111519F7AF1025D","<img src=\"lumis/portal/client/images/FieldFailedValidation.gif\"></img>","Required field");LumisDouiErrorSummaryAddMessage('Form_8A488A03115169250111519610B501B6_lum_errorSummary',"Required field"); return false;} else {LumisDouiValidatorSetMessages('Form_8A488A03115169250111519610B501B68A488A03115169250111519F7AF1025D','',''); return true;};}</script> <data> <clientUniqueId>Form_8A488A03115169250111519610B501B68A488A03115169250111519F7AF1025D</clientUniqueId> </data> </control>

Since:

4.0.0

Field Summary

Fields inherited from class lumis.doui.control.ValidatorControl

clientSideValidationEnabled, DEFAULT_VALUE, ERROR_TYPE_CONTROL_BEING_VALIDATED_IS_NOT_CLIENT_SIDE_READABLE, ERROR_TYPE_ERROR_VALIDATING_CONTROL, messages, SOURCE_FIELD_NAME_UNDEFINED, validateOnClientSideEvents

Fields inherited from class lumis.doui.control.Control

childControls, controlContainer, controlDefinitionNode, controlResource, douiContext, hasValidatorSubControls, isValid, locale, ON_EVENT_CLOSE_WINDOW, ON_EVENT_LINK, ON_EVENT_POPUP_LINK_OR_RUNTIME_INTERFACE, ON_EVENT_POPUP_RUNTIME_INTERFACE, ON_EVENT_PROCESS_ACTION, ON_EVENT_RENDER_ACTION, ON_EVENT_REPLACE_INTERFACE, ON_EVENT_SCRIPT, onEventScripts, PARAMETER_TYPE_FIRST_SELECTED, PARAMETER_TYPE_GET_VALUE, parentControl, resources, type, VALIDATION_SELECTED_MANY, VALIDATION_SELECTED_ONE

Constructor Summary

RequiredValueValidatorControl()

Method Summary

boolean	doServerValidation() Performs the server validation of the controls for this validator.
IResource	getControlResource()
protected ValidationMessages	getDefaultMessages(String errorType)
String	getScriptValidationFunctionImplementation() Returns the client side code that must be placed in a client side function to perform the validation

Methods inherited from class lumis.doui.control.ValidatorControl

getClientUniqueId, getControlToValidate, getControlToValidateIds, getControlToValidateSourceFieldName, getDefaultMessageParameters, getMessages, getMessages, getScriptClear, getScriptSetMessages, getScriptSetMessages, getScriptSetMessages, getScriptValidate, getScriptValidateRegistration, getScriptValidationFunctionName, includeScripts, init, isClientSideValidationEnabled, isValidateOnlyIfVisible, serverValidate, setRenderData

Methods inherited from class lumis.doui.control.Control

appendSubControl, appendSubControls, applyOnEventScripts, buildSubControls, convertToStandardValue, createContainer, disconnect, fixedIdentifierRequired, generateControlId, getAdditionalParameters, getAdditionalParameters, getAncestor, getChildControls, getClientEventHandlerScript, getId, getLocale, getNamespace, getParentControl, getPrepareForReadScript, getRenderData, getResources, getRuntimeDefaultSource, getScriptActionValidation, getScriptGetValues, getScriptGetValuesFunctionImplementation, getScriptGetValuesFunctionName, getScriptGetValuesRegistration, getSourceContext, getStringsToLocalize, getType, getValidationScript, isValid, localize, localizeStrings, processCustomTags, registerOnEventScript, removeChild, removeChildren, resolveVariable, setRuntimeAttributes, setValid

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.doui.control.IControl

buildSubControls, createContainer, disconnect, getChildControls, getId, getParentControl, getPrepareForReadScript, getRenderData, getResources, getType, isValid, registerOnEventScript, removeChild, removeChildren, setRuntimeAttributes, setValid

Constructor Detail

RequiredValueValidatorControl

public RequiredValueValidatorControl()

Method Detail

doServerValidation

public boolean doServerValidation()
                           throws ControlException,
                                  PortalException

Description copied from class: ValidatorControl

Performs the server validation of the controls for this validator.

Overrides:

doServerValidation in class ValidatorControl

Returns:

false if the validation failed, true otherwise.

Throws:

ControlException

PortalException

See Also:

ValidatorControl.serverValidate()

getScriptValidationFunctionImplementation

public String getScriptValidationFunctionImplementation()
                                                 throws ControlException,
                                                        PortalException

Description copied from interface: IValidatorControl

Returns the client side code that must be placed in a client side function to perform the validation

Returns:

a String.

Throws:

PortalException

ControlException

getDefaultMessages

protected ValidationMessages getDefaultMessages(String errorType)
                                         throws ControlException,
                                                PortalException

Overrides:

getDefaultMessages in class ValidatorControl

Throws:

ControlException

PortalException

getControlResource

public IResource getControlResource()
                             throws PortalException

Specified by:

getControlResource in interface IControl

Overrides:

getControlResource in class ValidatorControl

Throws:

PortalException