|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.nucleus.logging.VariableArgumentApplicationLoggingImpl atg.nucleus.logging.ApplicationLoggingImpl atg.commerce.order.processor.ProcValidateInvoiceRequest
public class ProcValidateInvoiceRequest
Validate a single instance of the InvoiceRequest payment group at checkout time. This processor verifies that all required fields in an InvoiceRequest are present and that they have acceptable values, to the extent that this can be determined in a generic way.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
protected int[] |
mRetCodes
|
Fields inherited from interface atg.service.pipeline.PipelineProcessor |
---|
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK |
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
---|
DEFAULT_LOG_TRACE_STATUS |
Fields inherited from interface atg.nucleus.logging.ApplicationLogging |
---|
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS |
Constructor Summary | |
---|---|
ProcValidateInvoiceRequest()
|
Method Summary | |
---|---|
protected void |
addHashedError(PipelineResult pResult,
java.lang.String pKey,
java.lang.String pId,
java.lang.Object pError)
This method adds an error to the PipelineResult object. |
BillingAddrValidator |
getBillingAddressValidator()
|
int |
getInvoiceRequestValidationMode()
Queries the mode to use for validating an invoice request. |
java.lang.String |
getLoggingIdentifier()
Return the LoggingIdentifier used in log messages. |
int[] |
getRetCodes()
Returns an array of all the return codes that could be returned by this PipelineProcessor. |
boolean |
isEmpty(java.lang.String pStr)
Return true if pStr is null or consists entirely of whitespace. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Verify that all required properties are provided in an instance of InvoiceRequest. |
void |
setBillingAddressValidator(BillingAddrValidator pBillingAddressValidator)
|
void |
setInvoiceRequestValidationMode(int pInvoiceRequestValidationMode)
Specifies the mode to use for validating an invoice request. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Set the LoggingIdentifier used in log messages. |
protected void |
validateBillingAddressFields(InvoiceRequest pPayment,
PipelineResult pResult,
java.util.Locale pLocale)
Validate the billing address in an invoice request. |
protected void |
validateInvoiceRequestFields(InvoiceRequest pPayment,
PipelineResult pResult,
java.util.ResourceBundle pResources)
Validate the properties specific to an invoice request based on the InvoiceRequestValidationMode property. |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
---|
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
protected int[] mRetCodes
Constructor Detail |
---|
public ProcValidateInvoiceRequest()
Method Detail |
---|
public void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
public void setBillingAddressValidator(BillingAddrValidator pBillingAddressValidator)
public BillingAddrValidator getBillingAddressValidator()
public void setInvoiceRequestValidationMode(int pInvoiceRequestValidationMode)
public int getInvoiceRequestValidationMode()
public int[] getRetCodes()
PipelineProcessor
getRetCodes
in interface PipelineProcessor
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other data
java.lang.Exception
protected void validateInvoiceRequestFields(InvoiceRequest pPayment, PipelineResult pResult, java.util.ResourceBundle pResources)
pPayment
- The InvoiceRequest payment group being checkedpResult
- The PipelineResult object containing a HashMap of error messagespResources
- The resource bundle to use when looking up error message stringsprotected void validateBillingAddressFields(InvoiceRequest pPayment, PipelineResult pResult, java.util.Locale pLocale)
pPayment
- The InvoiceRequest payment group being checkedpResult
- The PipelineResult object containing a HashMap of error messagespLocale
- The locale that the billing address validator component should
use to look up error messages.public boolean isEmpty(java.lang.String pStr)
protected void addHashedError(PipelineResult pResult, java.lang.String pKey, java.lang.String pId, java.lang.Object pError)
pResult
- the PipelineResult object supplied in runProcess()pKey
- the key to use to store the HashMap in the PipelineResult objectpId
- the key to use to store the error message within the HashMap in the
PipelineResult objectpError
- the error object to store in the HashMapPipelineResult
,
runProcess(Object, PipelineResult)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |