com.ibm.etill.framework.payapi
Class NumericTokenValidationItem

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

public class NumericTokenValidationItem
extends StringValidationItem
implements PaymentAPIConstants

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

A numeric token parameter is a String parameter that represents a number with the following constraints: a null value is not allowed, the numeric string cannot contain leading zeros, the numeric string cannot be negative, the string has a minimum length of 1 and a maximum length of 9.

See Also:
StringValidationItem, ParameterTable

 
Constructor Summary
NumericTokenValidationItem(String parameterName, short returnCode)
          Constructor Initialize this NumericTokenValidationItem with the name of the parameter and the API failure return code.
 
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

NumericTokenValidationItem

public NumericTokenValidationItem(String parameterName,
                                  short returnCode)
Constructor Initialize this NumericTokenValidationItem with the name of the parameter and the API failure return code. By default, a valid numeric token string cannot be null.
Parameters:
parameterName - name given to identify this parameter
returnCode - The return code to return in the API response if parameter fails validation.