|
|||||||||
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.approval.processor.ProcAddApproverIdsToOrder
public class ProcAddApproverIdsToOrder
This processor adds the list of valid approver ids to the approverIds property of the order. If no approvers are defined, then an exception is thrown unless the allowCheckoutIfApproversNotDefined property is set to true. Then, the order will just be checked out without approval. The default value of allowCheckoutIfApproversNotDefined is false.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
|
static int |
SUCCESS
|
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 | |
---|---|
ProcAddApproverIdsToOrder()
Creates a new ProcAddApproverIdsToOrder instance. |
Method Summary | |
---|---|
boolean |
getAllowCheckoutIfApproversNotDefined()
Returns the allowCheckoutIfApproversNotDefined |
java.lang.String |
getApproversPropertyName()
Returns property approversPropertyName |
java.lang.String |
getProfileItemDescName()
Return the profileItemDescName property. |
ProfileTools |
getProfileTools()
Return the ProfileTools property. |
int[] |
getRetCodes()
The return codes that this processor can return. |
protected RepositoryItem |
loadProfile(Order pOrder)
Loads the profile for the given order |
int |
runProcess(java.lang.Object pParam,
PipelineResult pResult)
This method adds the list of valid approver ids to the approverIds property of the order. |
void |
setAllowCheckoutIfApproversNotDefined(boolean pAllowCheckoutIfApproversNotDefined)
Sets the allowCheckoutIfApproversNotDefined |
void |
setApproversPropertyName(java.lang.String pApproversPropertyName)
Sets property approversPropertyName |
void |
setProfileItemDescName(java.lang.String pProfileItemDescName)
Set the profileItemDescName property. |
void |
setProfileTools(ProfileTools pProfileTools)
Set the ProfileTools 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
public static final int SUCCESS
Constructor Detail |
---|
public ProcAddApproverIdsToOrder()
ProcAddApproverIdsToOrder
instance.
Method Detail |
---|
public java.lang.String getApproversPropertyName()
public void setApproversPropertyName(java.lang.String pApproversPropertyName)
pApproversPropertyName
- the value to set for property approversPropertyNamepublic java.lang.String getProfileItemDescName()
public void setProfileItemDescName(java.lang.String pProfileItemDescName)
pProfileItemDescName
- public ProfileTools getProfileTools()
public void setProfileTools(ProfileTools pProfileTools)
pProfileTools
- public boolean getAllowCheckoutIfApproversNotDefined()
public void setAllowCheckoutIfApproversNotDefined(boolean pAllowCheckoutIfApproversNotDefined)
public int runProcess(java.lang.Object pParam, PipelineResult pResult) throws java.lang.Exception
runProcess
in interface PipelineProcessor
pParam
- list of params to pipelinepResult
- the pipeline result object
java.lang.Exception
- if an error occursprotected RepositoryItem loadProfile(Order pOrder) throws RepositoryException
RepositoryException
public int[] getRetCodes()
getRetCodes
in interface PipelineProcessor
int[]
of the valid return codes
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |