com.ibm.etill.framework.payapi
Class PathValidationItem

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

public class PathValidationItem
extends ParameterValidationItem
implements PaymentAPIConstants

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

The validation will ensure that the specified path is a valid directory name with write permission.

See Also:
ParameterValidationItem, ParameterTable

 
Constructor Summary
PathValidationItem(String parameterName, short returnCode, boolean nullValuesAllowed, Integer maxLength)
          Constructor Initialize this PathValidationItem with the name of the parameter, the API failure return code, whether to allow null values, and the maximum allowable length of the parameter.
 
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

PathValidationItem

public PathValidationItem(String parameterName,
                          short returnCode,
                          boolean nullValuesAllowed,
                          Integer maxLength)
Constructor Initialize this PathValidationItem with the name of the parameter, the API failure return code, whether to allow null values, and the maximum allowable length of the parameter.
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
maxLength - Integer object that represents the maximum length of the path