public class ProcCheckRequisitionNumbers extends GenericService implements PipelineProcessor
This processor can also add an error message to the pipeline result
object in cases where the order specifies a requisition number, which
allows the ProcExecuteChain
processor to return a different value to an enclosing
pipeline chain.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
SERVICE_INFO_KEY
STOP_CHAIN_EXECUTION, STOP_CHAIN_EXECUTION_AND_COMMIT, STOP_CHAIN_EXECUTION_AND_ROLLBACK
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
ProcCheckRequisitionNumbers() |
Modifier and Type | Method and Description |
---|---|
int |
getRequisitionNotUsedValue()
Get the value to return if an order does not contain requisition numbers
in any of its payment groups.
|
java.lang.String |
getRequisitionUsedPipelineMessage()
Get the string to use as the error object if
requisitionUsedAddsPipelineError is true and the order
contains requisition numbers in any of its payment groups. |
int |
getRequisitionUsedValue()
Set the value to return if an order does contain requisition numbers
associated with any of its payment groups.
|
int[] |
getRetCodes()
Return an array of possible return values for this processor.
|
protected boolean |
isBlank(java.lang.String pStr)
Return true if the string specified by pStr is null, an empty
string, or consists entirely of whitespace.
|
boolean |
isRequisitionUsedAddsPipelineError()
Query whether to add an error object to the pipeline result if
an order contains requisition numbers in any of its payment groups.
|
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
Iterate over payment groups in an order, returning
requisitionUsedValue if any payment group in
the order specifies a requisition number, and returning
requisitionNotUsedValue and optionally
adding an error to the pipeline result otherwise. |
void |
setRequisitionNotUsedValue(int pRequisitionNotUsedValue)
Set the value to return if an order does not contain requisition numbers
in any of its payment groups.
|
void |
setRequisitionUsedAddsPipelineError(boolean pRequisitionUsedAddsPipelineError)
Specify whether to add an error object to the pipeline result if
an order contains requisition numbers in any of its payment groups.
|
void |
setRequisitionUsedPipelineMessage(java.lang.String pRequisitionUsedPipelineMessage)
Ste the string to use as the error object if
requisitionUsedAddsPipelineError is true and the order
contains requisition numbers in any of its payment groups. |
void |
setRequisitionUsedValue(int pRequisitionUsedValue)
Set the value to return if an order does contain requisition numbers
associated with any of its payment groups.
|
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, 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, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws InvalidParameterException
requisitionUsedValue
if any payment group in
the order specifies a requisition number, and returning
requisitionNotUsedValue
and optionally
adding an error to the pipeline result otherwise.runProcess
in interface PipelineProcessor
pParam
- an optional user parameterpResult
- the PipelineResult object which is used to return errors or other dataInvalidParameterException
public int[] getRetCodes()
requisitionUsedValue
and requisitionNotUsedValue
.getRetCodes
in interface PipelineProcessor
protected boolean isBlank(java.lang.String pStr)
public void setRequisitionUsedValue(int pRequisitionUsedValue)
public int getRequisitionUsedValue()
public void setRequisitionNotUsedValue(int pRequisitionNotUsedValue)
public int getRequisitionNotUsedValue()
public void setRequisitionUsedAddsPipelineError(boolean pRequisitionUsedAddsPipelineError)
public boolean isRequisitionUsedAddsPipelineError()
public void setRequisitionUsedPipelineMessage(java.lang.String pRequisitionUsedPipelineMessage)
requisitionUsedAddsPipelineError
is true and the order
contains requisition numbers in any of its payment groups.public java.lang.String getRequisitionUsedPipelineMessage()
requisitionUsedAddsPipelineError
is true and the order
contains requisition numbers in any of its payment groups.