atg.b2bcommerce.invoice.pipeline
Class CopyInvoiceRequestProperties
java.lang.Object
atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
atg.nucleus.GenericService
atg.b2bcommerce.invoice.pipeline.CopyInvoiceRequestProperties
- All Implemented Interfaces:
- NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, PipelineProcessor, java.util.EventListener
public class CopyInvoiceRequestProperties
- extends GenericService
- implements PipelineProcessor
Pipeline processor that copies invoice properties from an
InvoiceRequestInfo object into an invoice repository item.
Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging |
DEFAULT_LOG_TRACE_STATUS |
Method Summary |
protected int |
getErrorReturnCode()
Return the value that the pipeline processor should return to the
pipeline chain in case of error. |
int[] |
getRetCodes()
Return all possible return values for this processor. |
boolean |
isRollbackOnError()
Query whether failure of this processor is considered a fatal error. |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Copy properties from an InvoiceRequestInfo object into the corresponding
Invoice repository item, where both objects are obtained from the invoice
pipeline arguments supplied to this pipeline processor. |
void |
setRollbackOnError(boolean pRollbackOnError)
Specify whether or failure in this processor is considered fatal
error. |
Methods inherited from class atg.nucleus.GenericService |
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService |
Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl |
vlogDebug, vlogDebug, vlogDebug, vlogDebug, 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 |
CLASS_VERSION
public static java.lang.String CLASS_VERSION
SUCCESS
public static final int SUCCESS
- See Also:
- Constant Field Values
RETCODES
public static final int[] RETCODES
CopyInvoiceRequestProperties
public CopyInvoiceRequestProperties()
setRollbackOnError
public void setRollbackOnError(boolean pRollbackOnError)
- Specify whether or failure in this processor is considered fatal
error. If this value is set to true, then any error in runProcess
processor to return a value meaning "abort execution and roll back
the current transaction". If this value is set to false, then errors
will be ignored and the pipeline processor will always return a
success status code. The default value is true.
isRollbackOnError
public boolean isRollbackOnError()
- Query whether failure of this processor is considered a fatal error.
runProcess
public int runProcess(java.lang.Object pParam,
PipelineResult pResult)
- Copy properties from an InvoiceRequestInfo object into the corresponding
Invoice repository item, where both objects are obtained from the invoice
pipeline arguments supplied to this pipeline processor.
- Specified by:
runProcess
in interface PipelineProcessor
- Parameters:
pParam
- Pipeline parameters, which should be an instance of InvoicePipelineArgs.pResult
- Standard pipeline result object.
- Returns:
- an integer value which is mapped to the next processor to execute. STOP_CHAIN_EXECUTION
will notify the PipelineManager to stop execution. An unmapped value will throw a
RunProcessException.
getErrorReturnCode
protected int getErrorReturnCode()
- Return the value that the pipeline processor should return to the
pipeline chain in case of error. The value returned is determined
by the setting of the
rollbackOnError
property.
getRetCodes
public int[] getRetCodes()
- Return all possible return values for this processor.
- Specified by:
getRetCodes
in interface PipelineProcessor
- Returns:
- an array of all the return codes that could be returned by this PipelineProcessor.