AuditAddressCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.TaskCommandImpl
    - - com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl
      - com.ibm.commerce.usermanagement.commands.AuditAddressCmdImpl

All Implemented Interfaces:

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

Direct Known Subclasses:

AuditUserRegistrationCmdImpl
```
public class AuditAddressCmdImpl
extends AuditBaseCmdImpl
implements AuditAddressCmd
```
Checks the parameters that are passed into the AddressAdd and AddressUpdate commands according to what is specified in the Address property file.
The command will get store directory from the CommandContext and use the store directory to find the property file. If the property file is not found, no parameter checks will be performed.
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
 
```
... Last name parameter will be checked as the 'Required' attribute for lastName equals 'yes'. If the lastName parameter were missing or its length equaled 0, the AuditAddressCmd will throw an exception.
First name parameter will NOT be checked since the 'Required' attribute for firstName equals 'no'.
If all parameters checks pass successfully, the getAuditResult() method will return true; otherwise it will return false.

Field Summary

Fields
Modifier and Type	Field and Description
`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.websphere.command.Command
serialVersionUID

Constructor Summary

Constructors
Constructor and Description

AuditAddressCmdImpl()
Creates an instance of the AuditAddress command.

Constructors
Constructor and Description
`AuditAddressCmdImpl()` Creates an instance of the AuditAddress command.

Method Summary

Methods
Modifier and Type	Method and Description
`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 address.
`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 address.

Methods inherited from class com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl
getAuditResult, getPathSeparator, getPropertyFileName, getRequestProperties, getStoreDirectory, setErrorViewName, setPathSeparator, setPropertyFileName, setStoreDirectory

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.usermanagement.commands.AuditBaseCmd
getRequestProperties, setErrorViewName, setPropertyFileName

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, 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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- 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 command implementation.
    
    See Also:
    
    Constant Field Values
  - istrLastName
```
protected java.lang.String istrLastName
```
    The last name of the individual.
  - istrFirstName
```
protected java.lang.String istrFirstName
```
    The first name of the individual.
  - istrAddress1
```
protected java.lang.String istrAddress1
```
    The first address line of the individual's street address.
  - istrCity
```
protected java.lang.String istrCity
```
    The name of the city where the individual resides.
  - istrState
```
protected java.lang.String istrState
```
    The name of the state, province, or equivalent where the individual resides.
  - istrZipCode
```
protected java.lang.String istrZipCode
```
    The zip code or equivalent postal code of the individual's address.
  - istrCountry
```
protected java.lang.String istrCountry
```
    The name of the country where the individual resides.
- Constructor Detail
  - AuditAddressCmdImpl
```
public AuditAddressCmdImpl()
```
    Creates an instance of the AuditAddress command.
- Method Detail
  - getAddress1
```
public java.lang.String getAddress1()
```
    Returns the first line of the address.
    
    Returns:
    
    The first line of the address.
  - getCity
```
public java.lang.String getCity()
```
    Returns the city name.
    
    Returns:
    
    The city name.
  - getCountry
```
public java.lang.String getCountry()
```
    Returns the country name.
    
    Returns:
    
    The country name.
  - getLastName
```
public java.lang.String getLastName()
```
    Returns the last name of the individual.
    
    Returns:
    
    The last name.
  - getState
```
public java.lang.String getState()
```
    Returns the name of the state, province, or equivalent where the individual resides.
    
    Returns:
    
    The name of the state.
  - getZipCode
```
public java.lang.String getZipCode()
```
    Returns the zip code or equivalent postal code of the individual's address.
    
    Returns:
    
    The zip code.
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Executes the business function.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AuditBaseCmdImpl
    
    Throws:
    
    ECException - If there was a problem executing the business function.
  - setAddress1
```
public void setAddress1(java.lang.String astrAddress1)
```
    Sets the first line of the address.
    
    Specified by:
    
    setAddress1 in interface AuditAddressCmd
    
    Parameters:
    
    astrAddress1 - The first line of the address.
  - setCity
```
public void setCity(java.lang.String astrCity)
```
    Sets the city name.
    
    Specified by:
    
    setCity in interface AuditAddressCmd
    
    Parameters:
    
    astrCity - The city name.
  - setCountry
```
public void setCountry(java.lang.String astrCountry)
```
    Sets the country name.
    
    Specified by:
    
    setCountry in interface AuditAddressCmd
    
    Parameters:
    
    astrCountry - The country name.
  - setFirstName
```
public void setFirstName(java.lang.String astrFirstName)
```
    Sets the First name of the individual.
    
    Parameters:
    
    astrFirstName - The First name.
  - setLastName
```
public void setLastName(java.lang.String astrLastName)
```
    Sets the last name of the individual.
    
    Specified by:
    
    setLastName in interface AuditAddressCmd
    
    Parameters:
    
    astrLastName - The last name.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty aRequestProperties)
                          throws ECApplicationException
```
    Sets the parameters passed to the command.
    
    Specified by:
    
    setRequestProperties in interface AuditAddressCmd
    
    Specified by:
    
    setRequestProperties in interface AuditBaseCmd
    
    Overrides:
    
    setRequestProperties in class AuditBaseCmdImpl
    
    Parameters:
    
    requestProperties - the parameters passed to the command.
    
    Throws:
    
    ECApplicationException - If there was a problem with missing or invalid parameters passed to the command.
  - setState
```
public void setState(java.lang.String astrState)
```
    Sets the name of the state, province, or equivalent where the individual resides.
    
    Specified by:
    
    setState in interface AuditAddressCmd
    
    Parameters:
    
    astrState - The name of the state.
  - setZipCode
```
public void setZipCode(java.lang.String astrZipCode)
```
    Sets the zip code or equivalent postal code of the individual's address.
    
    Specified by:
    
    setZipCode in interface AuditAddressCmd
    
    Parameters:
    
    astrZipCode - The zip code.

Class AuditAddressCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.usermanagement.commands.AuditBaseCmdImpl

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Field Detail

COPYRIGHT

CLASSNAME

istrLastName

istrFirstName

istrAddress1

istrCity

istrState

istrZipCode

istrCountry

Constructor Detail

AuditAddressCmdImpl

Method Detail

getAddress1

getCity

getCountry

getLastName

getState

getZipCode

performExecute

setAddress1

setCity

setCountry

setFirstName

setLastName

setRequestProperties

setState

setZipCode