com.ibm.commerce.order.commands

Interface OrderTransferCheckCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

OrderTransferCheckCmdImpl

public interface OrderTransferCheckCmd
extends ControllerCommand

This Order controller command is used to check if confirmation has been received for the specified order transferred to an external system. And re-direct to one of four specified URLs depending on the result of the check.

The redirect URL may be:

• OKURL: The redirection URL that is returned if transfer confirmation for specified oder have been received.
• TimeoutURL: 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.
• ErrorURL: The redirection URL that is returned if transfer is failed.
• WaitURL: The redirection URL that is returned if transfer confirmation has not yet been received, and a timeoutInterval+orderLastUpdateTime is less than the current time.

The default implementation of this command is OrderTransferCheckCmdImpl. The OrderTransferCheck URL is mapped to this command by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT The IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default implementation of this command.
static java.lang.String	NAME The full name of this command.

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
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.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

The IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The full name of this command.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

Method Detail

setOrderIds

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

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

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

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

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

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

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

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

void setErrorUrl(java.lang.String astrErrorUrl)

Sets the error URL.

Parameters:

astrErrorUrl - The error URL to set