com.ibm.etill.framework.payapi
Class RestrictedStringValidationItem

java.lang.Object
  |
  +--com.ibm.etill.framework.payapi.ParameterValidationItem
        |
        +--com.ibm.etill.framework.payapi.StringValidationItem
              |
              +--com.ibm.etill.framework.payapi.RestrictedStringValidationItem
All Implemented Interfaces:
FrameworkReturnCodes, com.ibm.etill.framework.payapi.validation.IParameterValidator, PaymentAPIConstants

public class RestrictedStringValidationItem
extends StringValidationItem
implements PaymentAPIConstants

The RestrictedStringValidationItem object is used to check that a parameter's value is a valid restricted string parameter and insert that parameter and it's value into a given ParameterTable if the verification passed.

A valid Restricted String is a string parameter that excludes certain characters. The excluded characters are passed into the constructor.

See Also:
StringValidationItem, ParameterTable

 
Constructor Summary
RestrictedStringValidationItem(String parameterName, short returnCode, boolean nullValuesAllowed, int minLength, int maxLength, String encoding, String excludedCharString)
          Constructor Initialize this RestricedStringValidationItem with the name of the parameter, the API failure return code, whether to allow null values, the minimum allowable length, the maximum allowable length, the character-encoding name, and a string of excluded characters.
 
Methods inherited from class com.ibm.etill.framework.payapi.ParameterValidationItem
getAliasKey, validateAndInsert, validateAndInsert, validateAndInsert
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RestrictedStringValidationItem

public RestrictedStringValidationItem(String parameterName,
                                      short returnCode,
                                      boolean nullValuesAllowed,
                                      int minLength,
                                      int maxLength,
                                      String encoding,
                                      String excludedCharString)
Constructor Initialize this RestricedStringValidationItem with the name of the parameter, the API failure return code, whether to allow null values, the minimum allowable length, the maximum allowable length, the character-encoding name, and a string of excluded characters.
Parameters:
parameterName - name given to identify this parameter
returnCode - The return code to return in the API response if parameter fails validation.
nullValuesAllowed - true to allow null values; false otherwise
minLength - minimum allowable length of the restricted string
maxLength - maximum allowable length of the restricted string
encoding - A character-encoding name
exludedCharString - A string of characters that cannot be included in a restricted string parameter