java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.order.commands.OrderTransferCheckCmdImpl
Check to see if confirmation has been received for the specified order transferred to an external system, and re-direct to one of three specified URLs depending on the result of the check.
Field Summary |
---|
Fields inherited from class com.ibm.commerce.command. ControllerCommandImpl |
requestProperties,
responseProperties,
retriable,
viewReqProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.order.commands. OrderTransferCheckCmd |
COPYRIGHT,
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECTargetableCommand |
COPYRIGHT |
Constructor Summary | |
---|---|
OrderTransferCheckCmdImpl() |
Method Summary | |
---|---|
protected
void |
addOutOrderIdName(
TypedProperty responseProperties, java.lang.String[] sOkOrderIds,
java.lang.String[] sWaitOrderIds,
java.lang.String[] sTimeoutOrderIds) This add the 3 types of out OrderId list to the response properties |
java.lang.String |
getErrorUrl() Gets the error url |
protected
java.lang.String |
getOkUrl() Gets the okURL property of the command. |
protected
OrderAccessBean[] |
getOrderAccessBeans() This method will first check if the local variable is set or not. |
protected
java.lang.Long[] |
getOrderIds() Gets the orderIds property of the command. |
protected
java.lang.String[] |
getOutOkOrderIdNames() this return the outOkOrderIdNames property of the command. |
protected
java.lang.String[] |
getOutTimeoutOrderIdNames() this return the outTimeoutOrderIdNames property of the command. |
protected
java.lang.String[] |
getOutWaitOrderIdNames() this return the outWaitOrderIdNames property of the command. |
AccessVector |
getResources() Gets the access vector accessed by this command. |
protected
java.lang.String |
getTimeoutUrl() Gets the timeoutURL property of the command. |
protected
java.lang.String |
getTransferMode() Gets the transferMode property of the command. |
protected
java.lang.String |
getWaitUrl() Gets the waitURL property of the command. |
void |
performExecute() Performs the main business logic of the command. |
void |
reset() Resets the instance variables of the command. |
void |
setErrorUrl(java.lang.String astrErrorUrl) Sets the error url |
void |
setOkUrl(java.lang.String url) Sets the okURL property of the command. |
void |
setOrderIds(java.lang.Long[] orderIds) Sets the orderIds property of the command. |
void |
setOutOkOrderIdNames(java.lang.String[] outOkOrderIdNames) Sets the outOkOrderIdNames property of the command. |
void |
setOutTimeoutOrderIdNames(java.lang.String[] outTimeoutOrderIdNames) Sets the outTimeoutOrderIdNames property of the command. |
void |
setOutWaitOrderIdNames(java.lang.String[] outWaitOrderIdNames) Sets the outWaitOrderIdNames property of the command. |
void |
setRequestProperties(
TypedProperty reqParms) The WebController calls the setRequestProperties method before invoking the execute method in this command. |
void |
setTimeoutUrl(java.lang.String url) Sets the timeoutURL property of the command. |
void |
setTransferMode(java.lang.String transferMode) Sets the transferMode property of the command. |
void |
setWaitUrl(java.lang.String url) Sets the waitURL property of the command. |
void |
validateParameters() Checks the validity of supplied parameters. |
Methods inherited from class com.ibm.commerce.command. ControllerCommandImpl |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
execute,
getGeneric,
getRequestProperties,
getResolvedRequestProperties,
getResponseProperties,
getRetriable,
getViewInputProperties,
isGeneric,
isRetriable,
mergeProperties,
setGeneric,
setRetriable,
setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command. AccCommand |
accessControlCheck,
getAccCheck,
getForUserId,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Constructor Detail |
---|
public OrderTransferCheckCmdImpl()
Method Detail |
---|
public void setOrderIds(java.lang.Long[] orderIds)
setOrderIds
in interface
OrderTransferCheckCmd
orderIds
- the order reference number of the Order for which
the confirmation will be checked.protected java.lang.Long[] getOrderIds()
public void setTransferMode(java.lang.String transferMode)
setTransferMode
in interface
OrderTransferCheckCmd
transferMode
- - 0 - order has been transferred without the
payment information (shopping cart transfer). 1 - order has been transferred
with the payment information (purchase order transfer).protected java.lang.String getTransferMode()
public void setOkUrl(java.lang.String url)
setOkUrl
in interface
OrderTransferCheckCmd
url
- - The redirection URL that is returned if transfer
confirmation for specified oder have been received.protected java.lang.String getOkUrl()
public void setTimeoutUrl(java.lang.String url)
setTimeoutUrl
in interface
OrderTransferCheckCmd
url
- - The redirection URL that is returned if transfer
confirmation has not yet been received, and a
timeoutInterval+orderLastUpdateTime is bigger or equal to the current
time.protected java.lang.String getTimeoutUrl()
public void setWaitUrl(java.lang.String url)
setWaitUrl
in interface
OrderTransferCheckCmd
url
- - The redirection URL that is returned if transfer
confirmation has not yet been received, and a
timeoutInterval+orderLastUpdateTime is less than the current
time.protected java.lang.String getWaitUrl()
public void setOutOkOrderIdNames(java.lang.String[] outOkOrderIdNames)
setOutOkOrderIdNames
in interface
OrderTransferCheckCmd
outOkOrderIdNames
- The names of name value pairs that should
be added to the redirection URL. The values of the added name value pairs are
the identifiers of the checked orders that have transfer
confirmations.protected java.lang.String[] getOutOkOrderIdNames()
public void setOutWaitOrderIdNames(java.lang.String[] outWaitOrderIdNames)
setOutWaitOrderIdNames
in interface
OrderTransferCheckCmd
outWaitOrderIdNames
- The names of name value pairs that
should be added to the redirection URL. The values of the added name value
pairs are the identifiers of the checked orders that do not yet have transfer
confirmations, but whose timeoutInterval+orderLastUpdateTime values are not
less than the current time.protected java.lang.String[] getOutWaitOrderIdNames()
public void setOutTimeoutOrderIdNames(java.lang.String[] outTimeoutOrderIdNames)
setOutTimeoutOrderIdNames
in interface
OrderTransferCheckCmd
outTimeoutOrderIdNames
- The names of name value pairs that
should be added to the redirection URL. The values of the added name value
pairs are the identifiers of the checked orders that do not yet have transfer
confirmations, but whose timeoutInterval+orderLastUpdateTime values are less
than the current time.protected java.lang.String[] getOutTimeoutOrderIdNames()
protected OrderAccessBean[] getOrderAccessBeans()
public AccessVector getResources() throws ECException
getResources
in interface
ECCommand
getResources
in class
AbstractECTargetableCommand
ECException
public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface
ControllerCommand
setRequestProperties
in class
ControllerCommandImpl
reqParms
- request properties
ECApplicationException
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
protected void addOutOrderIdName(TypedProperty responseProperties, java.lang.String[] sOkOrderIds, java.lang.String[] sWaitOrderIds, java.lang.String[] sTimeoutOrderIds)
responseProperties
- The responding TypedPropertysOkOrderIds
- String Array of ok OrderIdsWaitOrderIds
- String Array of wait OrderIdsTimeoutOrderIds
- String Array of timeout
OrderIdpublic void reset()
This is useful if the command instance is to be called multiple times with different command parameters.
reset
in class
AbstractECTargetableCommand
public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
ECException.
ECException
public java.lang.String getErrorUrl()
public void setErrorUrl(java.lang.String astrErrorUrl)
setErrorUrl
in interface
OrderTransferCheckCmd
astrErrorUrl
- The error url to set