|
|||||||||
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.ProcValidateGiftCertificate
public class ProcValidateGiftCertificate
Validate a single instance of the GiftCertificate payment group at checkout time. This processor verifies that all required fields in a GiftCertificate 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
Class version string |
protected int[] |
mRetCodes
Returns the set of valid return codes for this processor. |
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 | |
---|---|
ProcValidateGiftCertificate()
|
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. |
ClaimableManager |
getClaimableManager()
Returns the claimableManager |
java.lang.String |
getLoggingIdentifier()
Returns property LoggingIdentifier |
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 a StoreCredit object has a non-empty store credit number, and that this number is recognized as valid by the claimable manager. |
void |
setClaimableManager(ClaimableManager pClaimableManager)
Sets the claimableManager which is used to validate repository existance of any claimable item existing as a PaymentGroup in the order. |
void |
setLoggingIdentifier(java.lang.String pLoggingIdentifier)
Sets property LoggingIdentifier |
protected void |
validateGiftCertificateFields(GiftCertificate pGiftCert,
PipelineResult pResult,
java.util.ResourceBundle resourceBundle)
This method validates the GiftCertificate properties. |
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 ProcValidateGiftCertificate()
Method Detail |
---|
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 validateGiftCertificateFields(GiftCertificate pGiftCert, PipelineResult pResult, java.util.ResourceBundle resourceBundle)
pStoreCredit
- a StoreCredit object to validatepublic 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)
public ClaimableManager getClaimableManager()
public void setClaimableManager(ClaimableManager pClaimableManager)
pClaimableManager
- the value to set for property claimableManagerpublic void setLoggingIdentifier(java.lang.String pLoggingIdentifier)
setLoggingIdentifier
in class ApplicationLoggingImpl
public java.lang.String getLoggingIdentifier()
getLoggingIdentifier
in class ApplicationLoggingImpl
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |