FieldValidatorBuilder (sdk 11.50 API)

java.lang.Object
- com.silanis.esl.sdk.builder.FieldValidatorBuilder

```
public class FieldValidatorBuilder
extends Object
```
FieldValidatorBuilder is a convenient class used to create field validators.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALPHABETIC_ERROR_MESSAGE`
`static String`	`ALPHABETIC_REGEX`
`static String`	`ALPHANUMERIC_ERROR_MESSAGE`
`static String`	`ALPHANUMERIC_REGEX`
`static String`	`DATEPICKER_ERROR_MESSAGE`
`static String`	`DEFAULT_DATEPICKER_FORMAT`
`static String`	`DEFAULT_REGEX`
`static String`	`EMAIL_ERROR_MESSAGE`
`static String`	`EMAIL_REGEX`
`static String`	`NUMERIC_ERROR_MESSAGE`
`static String`	`NUMERIC_REGEX`
`static String`	`URL_ERROR_MESSAGE`
`static String`	`URL_REGEX`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FieldValidatorBuilder`	`alphabetic()` Creates an Alphabetic based field validator.
`static FieldValidatorBuilder`	`alphanumeric()` Creates an Alphanumeric based field validator.
`static FieldValidatorBuilder`	`basic()` There would be no field validator.
`FieldValidator`	`build()` Builds the actual FieldValidator with the values specified.
`static FieldValidatorBuilder`	`datepickerFormat()` Creates a default datepicker format.
`static FieldValidatorBuilder`	`datepickerFormat(String format)` Creates a default datepicker format.
`FieldValidatorBuilder`	`disabled()` Set that the field is disabled, signer is not allowed to modify a field value.
`static FieldValidatorBuilder`	`email()` Creates an Email based field validator.
`FieldValidatorBuilder`	`maxLength(int maxLength)` Sets the maximum length of the input allowed.
`FieldValidatorBuilder`	`minLength(int minLength)` Set the minimum length of the input allowed
`static FieldValidatorBuilder`	`numeric()` Creates a Numeric based field validator.
`static FieldValidatorBuilder`	`regex(String regex)` Creates a Regex based field validator.
`FieldValidatorBuilder`	`required()` Set that the field is mandatory to be filled before the signer is allowed to complete signing his document.
`FieldValidatorBuilder`	`setGroup(String group)` Set the group for the checkbox
`FieldValidatorBuilder`	`setMaximumRequired(int maximumRequired)` Set the maximumRequired for the checkboxes group
`FieldValidatorBuilder`	`setMinimumRequired(int minimumRequired)` Set the minimumRequired for the checkboxes group
`static FieldValidatorBuilder`	`url()` Creates an URL based field validator.
`FieldValidatorBuilder`	`withErrorMessage(String errorMessage)` Sets the error message returned to the end user should the validator not validate the input.
`FieldValidatorBuilder`	`withOption(String option)` Add an option to the options list The first option of the list defines the group for the radio buttons

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EMAIL_REGEX
```
public static final String EMAIL_REGEX
```
    See Also:
    
    Constant Field Values
  - URL_REGEX
```
public static final String URL_REGEX
```
    See Also:
    
    Constant Field Values
  - ALPHABETIC_REGEX
```
public static final String ALPHABETIC_REGEX
```
    See Also:
    
    Constant Field Values
  - ALPHANUMERIC_REGEX
```
public static final String ALPHANUMERIC_REGEX
```
    See Also:
    
    Constant Field Values
  - NUMERIC_REGEX
```
public static final String NUMERIC_REGEX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_REGEX
```
public static final String DEFAULT_REGEX
```
  - DEFAULT_DATEPICKER_FORMAT
```
public static final String DEFAULT_DATEPICKER_FORMAT
```
    See Also:
    
    Constant Field Values
  - ALPHABETIC_ERROR_MESSAGE
```
public static final String ALPHABETIC_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - ALPHANUMERIC_ERROR_MESSAGE
```
public static final String ALPHANUMERIC_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - NUMERIC_ERROR_MESSAGE
```
public static final String NUMERIC_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - EMAIL_ERROR_MESSAGE
```
public static final String EMAIL_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - URL_ERROR_MESSAGE
```
public static final String URL_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
  - DATEPICKER_ERROR_MESSAGE
```
public static final String DATEPICKER_ERROR_MESSAGE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - url
```
public static FieldValidatorBuilder url()
```
    Creates an URL based field validator. The allowed values should match an URL address.
    
    Returns:
    
    an URL address field validator builder
  - email
```
public static FieldValidatorBuilder email()
```
    Creates an Email based field validator. The allowed values should match an Email address.
    
    Returns:
    
    an Email address field validator builder
  - alphabetic
```
public static FieldValidatorBuilder alphabetic()
```
    Creates an Alphabetic based field validator. The allowed values should match an Alphabetic value.
    
    Returns:
    
    an Alphabetic value field validator builder
  - alphanumeric
```
public static FieldValidatorBuilder alphanumeric()
```
    Creates an Alphanumeric based field validator. The allowed values should match an Alphanumeric value.
    
    Returns:
    
    an Alphanumeric value field validator builder
  - numeric
```
public static FieldValidatorBuilder numeric()
```
    Creates a Numeric based field validator. The allowed values should match a Numeric value.
    
    Returns:
    
    a Numeric value field validator builder
  - datepickerFormat
```
public static FieldValidatorBuilder datepickerFormat()
```
    Creates a default datepicker format. The format is "YYYY-MM-dd".
    
    Returns:
    
    a field validator builder
  - datepickerFormat
```
public static FieldValidatorBuilder datepickerFormat(String format)
```
    Creates a default datepicker format.
    
    Parameters:
    
    format - string that user want to use, for example, "YYYY-dd-MM", "MM-dd-YYYY", "dd-MM-YYYY", "MMM dd, YYYY", "MMMM dd, YYYY".
    
    Returns:
    
    a Numeric value field validator builder
  - regex
```
public static FieldValidatorBuilder regex(String regex)
```
    Creates a Regex based field validator. The allowed values should match the Regex expression.
    
    Returns:
    
    a Regex expression field validator builder
  - basic
```
public static FieldValidatorBuilder basic()
```
    There would be no field validator.
    
    Returns:
    
    a field validator builder that does no validation
  - withErrorMessage
```
public FieldValidatorBuilder withErrorMessage(String errorMessage)
```
    Sets the error message returned to the end user should the validator not validate the input.
    
    Parameters:
    
    errorMessage - @size(max="255")
    
    Returns:
  - minLength
```
public FieldValidatorBuilder minLength(int minLength)
```
    Set the minimum length of the input allowed
    
    Parameters:
    
    minLength -
    
    Returns:
  - maxLength
```
public FieldValidatorBuilder maxLength(int maxLength)
```
    Sets the maximum length of the input allowed.
    
    Parameters:
    
    maxLength -
    
    Returns:
  - withOption
```
public FieldValidatorBuilder withOption(String option)
```
    Add an option to the options list The first option of the list defines the group for the radio buttons
    
    Parameters:
    
    option - @size(max="255")
    
    Returns:
  - required
```
public FieldValidatorBuilder required()
```
    Set that the field is mandatory to be filled before the signer is allowed to complete signing his document.
    
    Returns:
  - disabled
```
public FieldValidatorBuilder disabled()
```
    Set that the field is disabled, signer is not allowed to modify a field value.
    
    Returns:
  - setGroup
```
public FieldValidatorBuilder setGroup(String group)
```
    Set the group for the checkbox
    
    Parameters:
    
    group - string.
    
    Returns:
    
    field validator builder
  - setMinimumRequired
```
public FieldValidatorBuilder setMinimumRequired(int minimumRequired)
```
    Set the minimumRequired for the checkboxes group
    
    Parameters:
    
    minimumRequired -
    
    Returns:
    
    field validator builder
  - setMaximumRequired
```
public FieldValidatorBuilder setMaximumRequired(int maximumRequired)
```
    Set the maximumRequired for the checkboxes group
    
    Parameters:
    
    maximumRequired -
    
    Returns:
    
    field validator builder
  - build
```
public FieldValidator build()
```
    Builds the actual FieldValidator with the values specified.
    
    Returns:

Class FieldValidatorBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMAIL_REGEX

URL_REGEX

ALPHABETIC_REGEX

ALPHANUMERIC_REGEX

NUMERIC_REGEX

DEFAULT_REGEX

DEFAULT_DATEPICKER_FORMAT

ALPHABETIC_ERROR_MESSAGE

ALPHANUMERIC_ERROR_MESSAGE

NUMERIC_ERROR_MESSAGE

EMAIL_ERROR_MESSAGE

URL_ERROR_MESSAGE

DATEPICKER_ERROR_MESSAGE

Method Detail

url

email

alphabetic

alphanumeric

numeric

datepickerFormat

datepickerFormat

regex

basic

withErrorMessage

minLength

maxLength

withOption

required

disabled

setGroup

setMinimumRequired

setMaximumRequired

build