com.ibm.commerce.order.commands
Interface OrderTransferCheckCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand
All Known Implementing Classes:
OrderTransferCheckCmdImpl

public interface OrderTransferCheckCmd
extends ControllerCommand

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
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.order.commands.OrderTransferCheckCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.order.commands.OrderTransferCheckCmd".
 
Method Summary
 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 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.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, 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, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.order.commands.OrderTransferCheckCmd".
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.order.commands.OrderTransferCheckCmdImpl".
See Also:
Constant Field Values
Method Detail

setOrderIds

public void setOrderIds(java.lang.Long[] orderIds)
Sets the orderIds property of the command.
Parameters:
orderIds - the order reference number of the Order for which the confirmation will be checked.

setTransferMode

public void setTransferMode(java.lang.String transferMode)
Sets the transferMode property of the command.
Parameters:
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).

setOkUrl

public void setOkUrl(java.lang.String url)
Sets the okURL property of the command.
Parameters:
url - - The redirection URL that is returned if transfer confirmation for specified oder have been received.

setTimeoutUrl

public void setTimeoutUrl(java.lang.String url)
Sets the timeoutURL property of the command.
Parameters:
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.

setWaitUrl

public void setWaitUrl(java.lang.String url)
Sets the waitURL property of the command.
Parameters:
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.

setOutOkOrderIdNames

public void setOutOkOrderIdNames(java.lang.String[] outOkOrderIdNames)
Sets the outOkOrderIdNames property of the command.
Parameters:
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.

setOutWaitOrderIdNames

public void setOutWaitOrderIdNames(java.lang.String[] outWaitOrderIdNames)
Sets the outWaitOrderIdNames property of the command.
Parameters:
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.

setOutTimeoutOrderIdNames

public void setOutTimeoutOrderIdNames(java.lang.String[] outTimeoutOrderIdNames)
Sets the outTimeoutOrderIdNames property of the command.
Parameters:
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.

setErrorUrl

public void setErrorUrl(java.lang.String astrErrorUrl)
Sets the error url
Parameters:
astrErrorUrl - The error url to set