com.ibm.commerce.usermanagement.commands

Interface AddressCheckCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand
    All Known Implementing Classes:
    AddressCheckCmdImpl

    public interface AddressCheckCmd
extends ControllerCommand
    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 processing 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)

    • Method Detail

      • getAddressCheck

        boolean getAddressCheck()
        Gets the boolean result indicating whether the member has any address entry.
        Returns:
        The boolean result indicating whether the member has any address entry
        • true - the member has at least one address entry
        • false - the member does not have any address entry

      • getAddressNoURL

        java.lang.String getAddressNoURL()
        Gets the URL that is called if the member does not have any address entry.
        Returns:
        The URL that is called if the member does not have any address entry.

      • getAddressYesURL

        java.lang.String getAddressYesURL()
        Gets the URL that is called if the member has at least one address entry.
        Returns:
        The URL that is called if the member has at least one address entry.

      • reset

        void reset()
        Resets all instance variables of the command to initial state so it can be used again.
        Specified by:
        reset in interface com.ibm.websphere.command.Command

      • setAddressNoURL

        void setAddressNoURL(java.lang.String astrAddressNoURL)
        Sets the URL that is called if the member does not have any address entry.
        Parameters:
        astrAddressNoURL - The URL that is called if the member does not have any address entry.

      • setAddressYesURL

        void setAddressYesURL(java.lang.String astrAddressYesURL)
        Sets the URL that is called if the member has at least one address entry.
        Parameters:
        astrAddressNoURL - The URL that is called if the member has at least one address entry.

      • setMemberId

        void setMemberId(java.lang.String astrMemberId)
        Sets the memberId of the member to check address.
        Parameters:
        astrMemberId - The memberId.
Skip navigation links