com.ibm.commerce.usermanagement.commands

Class AddressCheckCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.usermanagement.commands.AddressBaseCmdImpl

com.ibm.commerce.usermanagement.commands.AddressCheckCmdImpl

All Implemented Interfaces:

AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, AddressBaseCmd, AddressCheckCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class AddressCheckCmdImpl
extends AddressBaseCmdImpl
implements AddressCheckCmd

Determines whether or not a user or organization has at least one permanent address.

Use this command with SSL (Secure Sockets Layer) to ensure that the information are encrypted. To do so, type the command with the HTTPS secure protocol.

The parameters yesURL and noURL are mandatory. The rest of the parameters are all optional.

Behavior

• Calls an empty task command PreAddressCheckCmd which can be customized for any pre-processing prior to execution of this command.
• memberId is used to specify the member (user, organization or organizational unit) to be checked. If memberId is not specified, the default is current user.
• Calls the URL specified by yesURL if at least one permanent address exists for the user Otherwise, calls the URL specified by noURL.
• Calls the AddressCheckErrorView view command is called if the command fails. Upon successful completion, the specified URL is called.
• Calls an empty task command PostAddressCheckCmd which can be customized for any further procesing post the execution of this command.

Exception Conditions

• yesURL or noURL is null (_ERR_CMD_MISSING_PARAM)
• The length of yesURL or noURL equals 0 (_ERR_CMD_INVALID_PARAM)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of the class.
static java.lang.String	COPYRIGHT IBM Copyright notice field.

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.usermanagement.commands.AddressCheckCmd

NAME

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

defaultCommandClassName

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

serialVersionUID

Fields inherited from interface com.ibm.commerce.usermanagement.commands.AddressBaseCmd

NAME

Constructor Summary

Constructors

Constructor and Description
AddressCheckCmdImpl()

Method Summary

Modifier and Type	Method and Description
boolean	getAddressCheck() Returns whether a permanent address exists.
java.lang.String	getAddressNoURL() Returns the URL to go to if there is no permanent address.
java.lang.String	getAddressYesURL() Returns the URL to go to if there is a permanent address.
void	performExecute() Determines whether the specified member identifier has an address associated with it.
void	reset() Reset the values in the values in the command.
void	setAddressNoURL(java.lang.String astrAddressNoURL) Sets the URL to go to if no permanent address can be found for the member.
void	setAddressYesURL(java.lang.String astrAddressYesURL) Sets the URL to go to if a permanent address can be found for the member.
void	setRequestProperties(TypedProperty reqProperties) Sets the parameters that were passed to the command.
void	validateParameters() Validates the parameters passed to the command.

Methods inherited from class com.ibm.commerce.usermanagement.commands.AddressBaseCmdImpl

getAddress1, getAddress2, getAddress3, getAddressId, getAddressType, getAuthenticateMode, getBestCallingTime, getBillingCode, getBillingCodeType, getBusinessTitle, getCity, getCountry, getCreatedTimestamp, getEmail1, getEmail2, getFax1, getFax2, getFirstName, getLastName, getMiddleName, getMobilePhone1, getMobilePhone1Country, getNickName, getOfficeAddress, getOrganizationName, getOrganizationUnitName, getOutAddressName, getPackageSuppression, getPersonTitle, getPhone1, getPhone1Type, getPhone2, getPhone2Type, getPrimary, getPublishPhone1, getPublishPhone2, getResources, getState, getStatus, getURL, getViewInputProperties, getZipCode, isReadyToCallExecute, setAddress1, setAddress2, setAddress3, setAddressField1, setAddressField2, setAddressField3, setAddressId, setAddressId, setAddressType, setAuthenticateMode, setBestCallingTime, setBillingCode, setBillingCodeType, setBillingCodeTypeType, setBusinessTitle, setCity, setCountry, setCreatedTimestamp, setEmail1, setEmail2, setFax1, setFax2, setFirstName, setLastName, setMemberId, setMemberId, setMiddleName, setMobilePhone1, setMobilePhone1Country, setNickName, setOfficeAddress, setOrganizationName, setOrganizationUnitName, setOutAddressName, setPackageSuppression, setPackageSuppression, setPersonTitle, setPhone1, setPhone1Type, setPhone2, setPhone2Type, setPrimary, setPrimary, setPublishPhone1, setPublishPhone1, setPublishPhone2, setPublishPhone2, setSelfAddress, setShippingGeoCode, setState, setStatus, setTaxGeoCode, setURL, setZipCode

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

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

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.usermanagement.commands.AddressCheckCmd

setMemberId

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.websphere.command.CacheableCommand

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

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

getCommandTarget, getCommandTargetName, hasOutputProperties, 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, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

isReadyToCallExecute

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

fulfills, getOwner

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

The name of the class.

See Also:

Constant Field Values

Constructor Detail

AddressCheckCmdImpl

public AddressCheckCmdImpl()

Method Detail

getAddressCheck

public boolean getAddressCheck()

Returns whether a permanent address exists.

Specified by:

getAddressCheck in interface AddressCheckCmd

Returns:

true if a permanent address exists, otherwise false.

getAddressNoURL

public java.lang.String getAddressNoURL()

Returns the URL to go to if there is no permanent address.

Specified by:

getAddressNoURL in interface AddressCheckCmd

Returns:

A URL to redirect to.

getAddressYesURL

public java.lang.String getAddressYesURL()

Returns the URL to go to if there is a permanent address.

Specified by:

getAddressYesURL in interface AddressCheckCmd

Returns:

A URL to redirect to.

performExecute

public void performExecute()
                    throws ECException

Determines whether the specified member identifier has an address associated with it. Then calls the PostAddressCheck command to perform some customized function that should be executed after the address check.

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AddressBaseCmdImpl

Throws:

ECException - if there is a problem with finding the addresses for the specified member or executing the PostAddressCheck command.

reset

public void reset()

Reset the values in the values in the command.

Specified by:

reset in interface AddressBaseCmd

Specified by:

reset in interface AddressCheckCmd

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AddressBaseCmdImpl

setAddressNoURL

public void setAddressNoURL(java.lang.String astrAddressNoURL)

Sets the URL to go to if no permanent address can be found for the member.

Specified by:

setAddressNoURL in interface AddressCheckCmd

Parameters:

url - the URL to go to after the command is executed.

setAddressYesURL

public void setAddressYesURL(java.lang.String astrAddressYesURL)

Sets the URL to go to if a permanent address can be found for the member.

Specified by:

setAddressYesURL in interface AddressCheckCmd

Parameters:

url - the URL to go to after the command is executed.

setRequestProperties

public void setRequestProperties(TypedProperty reqProperties)
                          throws ECApplicationException

Sets the parameters that were passed to the command. This is done by calling the ProcessRequestProperties and PreAddressCheck command.

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class AddressBaseCmdImpl

Parameters:

reqProperties - The parameters passed to the command

Throws:

ECApplicationException - if there was an exception from calling the ProcessRequestProperties and PreAddressCheck command.

validateParameters

public void validateParameters()
                        throws ECException

Validates the parameters passed to the command.

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AddressBaseCmdImpl

Throws:

ECException - if a require parameter is missing or a given parameter has an invalid value.