com.ibm.etill.framework.payapi
Class NumericTokensValidationItem

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

public class NumericTokensValidationItem
extends StringValidationItem
implements PaymentAPIConstants

The NumericTokensValidationItem object is used to check that a parameter's value is a valid NumericTokens parameter and insert that parameter and a Vector, containing a String for each validated NumericToken, into a given ParameterTable if the verification passed.

The allowed value is one or more numeric tokens, as described in the paragraph below, separated by semicolons. If any of the numeric tokens fails validation, an ETillAbortOperationException will be thrown.

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
NumericTokensValidationItem(String parameterName, short returnCode)
          Constructor Initialize this NumericTokensValidationItem 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

NumericTokensValidationItem

public NumericTokensValidationItem(String parameterName,
                                   short returnCode)
Constructor Initialize this NumericTokensValidationItem 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.