com.ibm.commerce.order.commands

Interface ValidateOrderAddressCmd

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:

GiftRegistryValidateOrderAddressCmdImpl, ValidateOrderAddressCmdImpl

public interface ValidateOrderAddressCmd
extends TaskCommand

This Order task command is used to validate the shipping or billing address for the order or orderitems using given criteria. The default implementation of this command is ValidateOrderAddressCmdImpl.

See Also:

ValidateOrderAddressCmdImpl

Field Summary

Fields

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

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAddressId() Gets the identifier of the address to be validated.
java.lang.String	getAddressType() Gets the type of address to validate
java.lang.Long	getContractId() Gets the identifier of the contract which is used to check if the address is defined by the Shipping TCs of this contract.
java.lang.Long	getMemberId() Gets the identifier of the member who is used to check if the address is owned by.
OrderAccessBean	getOrder() Gets the order
java.lang.Long	getTcId() Gets the identifier of the PaymentTC terms and conditions object which could be used to check if the address is defined by the PaymentTC.
boolean	isCheckPermanent() Gets the flag which indicates whether to check the address is permanent or not.
void	setAddressId(java.lang.Long anAddressId) Sets the identifier of the address to be validated which is a required parameter.
void	setAddressType(java.lang.String anAddressType) Sets the type of address to validate.
void	setCheckPermanent(boolean aCheckPermanent) Sets the flag which indicates whether to check the address is permanent or not.
void	setContractId(java.lang.Long aContractId) Sets the identifier of the contract which is used to check if the address is defined by the Shipping TCs of this contract.
void	setMemberId(java.lang.Long aMemberId) Sets the identifier of the member.
void	setOrder(OrderAccessBean anOrderAB) Sets the order
void	setTcId(java.lang.Long aTcId) Sets the identifier of the PaymentTC terms and conditions object which could be used to check if the address is defined by the PaymentTC.

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 note field.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default implementation of this command.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

Method Detail

setAddressId

void setAddressId(java.lang.Long anAddressId)

Sets the identifier of the address to be validated which is a required parameter. AddressId must be set before the command execution by this method.

Parameters:

anAddressId - the identifier of the address to be validated.

getAddressId

java.lang.Long getAddressId()

Gets the identifier of the address to be validated.

Returns:

the identifier of the address to be validated.

setMemberId

void setMemberId(java.lang.Long aMemberId)

Sets the identifier of the member. The validation logic will check if the address is owned by this member. If the memberId is not specified, the default value is the user identifier in the session.

Parameters:

aMemberId - the member identifier.

getMemberId

java.lang.Long getMemberId()

Gets the identifier of the member who is used to check if the address is owned by.

Returns:

the identifier of a member.

setContractId

void setContractId(java.lang.Long aContractId)

Sets the identifier of the contract which is used to check if the address is defined by the Shipping TCs of this contract.

Parameters:

aContractId - the identifier of a contract.

getContractId

java.lang.Long getContractId()

Gets the identifier of the contract which is used to check if the address is defined by the Shipping TCs of this contract.

Returns:

the identifier of a contract .

setTcId

void setTcId(java.lang.Long aTcId)

Sets the identifier of the PaymentTC terms and conditions object which could be used to check if the address is defined by the PaymentTC.

Parameters:

aTcId - the identifier of the terms and conditions object.

getTcId

java.lang.Long getTcId()

Gets the identifier of the PaymentTC terms and conditions object which could be used to check if the address is defined by the PaymentTC.

Returns:

the identifier of the terms and conditions object .

setCheckPermanent

void setCheckPermanent(boolean aCheckPermanent)

Sets the flag which indicates whether to check the address is permanent or not. If the flag is not specified, the default value is true.

Parameters:

aCheckPermanent - a flag to indicate whether to check an address is permanent or not.

isCheckPermanent

boolean isCheckPermanent()

Gets the flag which indicates whether to check the address is permanent or not.

Returns:

false indicates not to check the address is permanent or not

true indicates need to check the address is permanent or not

setOrder

void setOrder(OrderAccessBean anOrderAB)

Sets the order

Parameters:

anOrderAB - the order used to validate the address against

getOrder

OrderAccessBean getOrder()

Gets the order

Returns:

the Order

setAddressType

void setAddressType(java.lang.String anAddressType)

Sets the type of address to validate.

Parameters:

anAddressType -

getAddressType

java.lang.String getAddressType()

Gets the type of address to validate

Returns:

the type of address to validate. Will be either "Shipping" or "Billing".