com.ibm.commerce.order.commands

Interface UpdateShipInfoCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

UpdateShipInfoCmdImpl

public interface UpdateShipInfoCmd
extends TaskCommand

This order task command is used to update shipping information.

If the data to be updated is of type shipping charge type/account number as opposed to shipping instructions. Then the address ID passed in is -1. If the data is not of that type, the address ID passed is that to store shipping instructions for.

The default implementation of this command is UpdateShipInfoCmdImpl.

Field Summary

Fields

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

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
void	setAddressId(java.lang.String addressId) This method sets the address ID of the SHIPINFO record.
void	setOrderId(java.lang.String orderId) This method sets the order ID of the SHIPINFO record.
void	setShipCarrAccntNum(java.lang.String shipCarrAccntNum) This method sets the carrier account number of the SHIPINFO record.
void	setShipChargeTypeId(java.lang.String shipChargeTypeId) This method sets the ship charge type ID of the SHIPINFO record.
void	setShipInstructions(java.lang.String shipInstructions) This method sets the ship instructions of the SHIPINFO record.
void	setShipModeId(java.lang.String shipModeId) This method sets the shipping mode ID of the SHIPINFO record.
void	setUpdateRequired(java.lang.String updateRequired) This method sets the type of update required to SHIPINFO.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

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.Command

isReadyToCallExecute, reset

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

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command interface.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The name of the default implementation class for this command interface.

See Also:

Constant Field Values

Method Detail

setOrderId

void setOrderId(java.lang.String orderId)

This method sets the order ID of the SHIPINFO record.

Parameters:

orderId - This is the orderId SHIPINFO record to update.

setAddressId

void setAddressId(java.lang.String addressId)

This method sets the address ID of the SHIPINFO record.

Parameters:

addressId - This the address ID the SHIPINFO record to update.

setShipModeId

void setShipModeId(java.lang.String shipModeId)

This method sets the shipping mode ID of the SHIPINFO record.

Parameters:

shipModeId - This is the shipping mode ID of the SHIPINFO record to update.

setShipInstructions

void setShipInstructions(java.lang.String shipInstructions)

This method sets the ship instructions of the SHIPINFO record.

Parameters:

shipInstructions - This is the new ship instructions for the SHIPINFO record.

setShipChargeTypeId

void setShipChargeTypeId(java.lang.String shipChargeTypeId)

This method sets the ship charge type ID of the SHIPINFO record.

Parameters:

shipChargeTypeId - This is the new shipping charge type for the SHIPINFO record.

setShipCarrAccntNum

void setShipCarrAccntNum(java.lang.String shipCarrAccntNum)

This method sets the carrier account number of the SHIPINFO record.

Parameters:

shipCarrAccntNum - This is the new carrier account number of the SHIPINFO record.

setUpdateRequired

void setUpdateRequired(java.lang.String updateRequired)

This method sets the type of update required to SHIPINFO. Whether that is an update to the shipping instructions or the carrier account info (that is charge type/account number)

Parameters:

updateRequired - This is the type of update being performed.