java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl | +--com.ibm.commerce.usermanagement.commands.AuditAddressCmdImpl
The AuditAddressCmd task command checks the parameters that are passed into the AddressAdd and AddressUpdate commands according what is specified in the Address property file. The command will get store directory from CommandContex and uses store directory to find property files. If property file is not found, the command will not check any parameters Following is a sample of the Address property file:
... lastName.Label=Last Name lastName.Displayed=yes lastName.Required=yes firstName.Label=First Name firstName.Displayed=yes firstName.Required=no... Following is a sample of the Address property file of new format:
... 40.Name=lastName 40.Label=Last Name 40.Displayed=yes 40.Required=yes 40.Size=20 45.Name=firstName 45.Label=First Name 45.Displayed=yes 45.Required=no 45.Size=20... Because the 'Required' attribute for lastName equals 'yes', the command will check the lastName parameter. If the lastName is missing or its length equals 0, the AuditAddressCmd will throw a excepiton. Because the 'Required' attribute for firstName equals 'no', the command will not check the firstName parameter.
If all parameters check are passed, the getAuditResult() method will return true; otherwise return false.
Field Summary | |
---|---|
static java.lang.String |
CLASSNAME The name of the command implementation. |
static java.lang.String |
COPYRIGHT IBM Copyright notice field. |
protected
java.lang.String |
istrAddress1 The first address line of the individual's street address. |
protected
java.lang.String |
istrCity The name of the city where the individual resides. |
protected
java.lang.String |
istrCountry The name of the country where the individual resides. |
protected
java.lang.String |
istrFirstName The first name of the individual. |
protected
java.lang.String |
istrLastName The last name of the individual. |
protected
java.lang.String |
istrState The name of the state, province, or equivalent where the individual resides. |
protected
java.lang.String |
istrZipCode The zip code or equivalent postal code of the individual's address. |
Fields inherited from class com.ibm.commerce.usermanagement.commands. AuditBaseCmdImpl |
ibResult,
ihshProperties,
ismpProperties,
istrErrorViewName,
istrPathSeparator,
istrPropertyFileName,
istrStoreDirectory,
requestProperties |
Fields inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.usermanagement.commands. AuditAddressCmd |
defaultCommandClassName,
NAME |
Fields inherited from interface com.ibm.commerce.command. ECCommand |
defaultCommandClassName |
Constructor Summary | |
---|---|
AuditAddressCmdImpl() Creates an instance of the AuditAddress comand. |
Method Summary | |
---|---|
java.lang.String |
getAddress1() Returns the first line of the address. |
java.lang.String |
getCity() Returns the city name. |
java.lang.String |
getCountry() Returns the country name. |
java.lang.String |
getLastName() Returns the last name of the individual. |
java.lang.String |
getState() Returns the name of the state, province, or equivalent where the individual resides. |
java.lang.String |
getZipCode() Returns the zip code or equivalent postal code of the individual's adddres. |
void |
performExecute() Executes the business function. |
void |
setAddress1(java.lang.String astrAddress1) Sets the first line of the address. |
void |
setCity(java.lang.String astrCity) Sets the city name. |
void |
setCountry(java.lang.String astrCountry) Sets the country name. |
void |
setFirstName(java.lang.String astrFirstName) Sets the First name of the individual. |
void |
setLastName(java.lang.String astrLastName) Sets the last name of the individual. |
void |
setRequestProperties(
TypedProperty aRequestProperties) Sets the parameters passed to the command. |
void |
setState(java.lang.String astrState) Sets the name of the state, province, or equivalent where the individual resides. |
void |
setZipCode(java.lang.String astrZipCode) Sets the zip code or equivalent postal code of the individual's adddres. |
Methods inherited from class com.ibm.commerce.usermanagement.commands. AuditBaseCmdImpl |
getAuditResult,
getPathSeparator,
getPropertyFileName,
getRequestProperties,
getStoreDirectory,
setErrorViewName,
setPathSeparator,
setPropertyFileName,
setStoreDirectory |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getResources,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties,
validateParameters |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.usermanagement.commands. AuditBaseCmd |
getRequestProperties,
setErrorViewName,
setPropertyFileName |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
protected java.lang.String istrLastName
protected java.lang.String istrFirstName
protected java.lang.String istrAddress1
protected java.lang.String istrCity
protected java.lang.String istrState
protected java.lang.String istrZipCode
protected java.lang.String istrCountry
Constructor Detail |
---|
public AuditAddressCmdImpl()
Method Detail |
---|
public java.lang.String getAddress1()
public java.lang.String getCity()
public java.lang.String getCountry()
public java.lang.String getLastName()
public java.lang.String getState()
public java.lang.String getZipCode()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AuditBaseCmdImpl
ECException
- If there was a problem executing the business function.public void setAddress1(java.lang.String astrAddress1)
setAddress1
in interface
AuditAddressCmd
astrAddress1
- The first line of the
address.public void setCity(java.lang.String astrCity)
setCity
in interface
AuditAddressCmd
astrCity
- The city name.public void setCountry(java.lang.String astrCountry)
setCountry
in interface
AuditAddressCmd
astrCountry
- The country name.public void setFirstName(java.lang.String astrFirstName)
astrFirstName
- The First name.public void setLastName(java.lang.String astrLastName)
setLastName
in interface
AuditAddressCmd
astrLastName
- The last name.public void setRequestProperties(TypedProperty aRequestProperties) throws ECApplicationException
setRequestProperties
in interface
AuditAddressCmd
setRequestProperties
in class
AuditBaseCmdImpl
aRequestProperties
- the parameters passed to the
command.
ECApplicationException
- If there was a problem with missing or
invalid parameters passed to the command.public void setState(java.lang.String astrState)
setState
in interface
AuditAddressCmd
astrState
- The name of the state.public void setZipCode(java.lang.String astrZipCode)
setZipCode
in interface
AuditAddressCmd
astrZipCode
- The zip code.