com.ibm.commerce.usermanagement.commands

Interface AuditAddressCmd

  • All Superinterfaces:
    AuditBaseCmd, 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 Subinterfaces:
    AuditUserRegistrationCmd
    All Known Implementing Classes:
    AuditAddressCmdImpl, AuditUserRegistrationCmdImpl

    public interface AuditAddressCmd
extends AuditBaseCmd
    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 Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        IBM Copyright notice field.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation of this command.
        See Also:
        Constant Field Values

    • Method Detail

      • setAddress1

        void setAddress1(java.lang.String astrAddressLine1)
        Sets the first line of the address.
        Parameters:
        astrAddressLine1 - The first line of the address

      • setCity

        void setCity(java.lang.String astrCity)
        Sets the city name.
        Parameters:
        astrCity - The city name.

      • setCountry

        void setCountry(java.lang.String astrCountry)
        Sets the country name.
        Parameters:
        astrCountry - The country name.

      • setLastName

        void setLastName(java.lang.String astrLastName)
        Sets the last name of the individual.
        Parameters:
        astrLastName - The last name.

      • setState

        void setState(java.lang.String astrState)
        Sets the name of the state, province, or equivalent where the individual resides.
        Parameters:
        astrState - The name of the state.

      • setZipCode

        void setZipCode(java.lang.String astrZipCode)
        Sets the zip code or equivalent postal code of the individual's address.
        Parameters:
        astrZipCode - The zip code.
Skip navigation links