com.ibm.commerce.usermanagement.commands
Interface AddressUpdateCmd
- All Known Implementing Classes:
- AddressUpdateCmdImpl
- public interface AddressUpdateCmd
This command update the address entry for a user, organization or organizational unit.
The information of the address is stored in the ADDRBOOK and ADDRESS tables.
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 URL and addressId are mandatory. The rest of the parameters are all optional.
Behavior
- Calls an empty task command PreAddressUpdateCmd. Store Developers can overwrite it change the input to the command.
- Can not update update a temporary address.
- Nickname can not be updated.
- For each address type, there can be zero or one primary address (primary field equals to 1).
If update this address to primary, then this command will change the existing primary in this address
type to not-primary.
- Check the required parameters.
- If the Authentication Mode is LDAP and this address is the self address (the selfAddress field equals to 1),
the address information may also be updated on the LDAP server.
- Call a task command AuditAddressCmd to perform additional parameter checking.
Store Developers need to add new code to AuditAddressCmd task command if they want to customerizable check.
- Insert a new address into the ADDRESS table with the specified nickname. The old address is marked
as temporary, and the new address is marked as permanent.
- If the command fails, the AddressErrorView view command is called. Upon successful completion, the specified URL is called.
- Calls an empty task command PostAddressUpateCmd. Store Developers can overwrite it to perform additional operations.
Exception Conditions
- URL is null (_ERR_CMD_MISSING_PARAM).
- The length of URL length equals 0 (_ERR_CMD_INVALID_PARAM).
- addressId is null (_ERR_CMD_MISSING_PARAM).
- addressId is not a foreign key set to the ADDRESS table or is pointed to a temporary address(_ERR_CMD_INVALID_PARAM).
- nickName should be same as the old nickname if there is nickName specified (_ERR_CMD_INVALID_PARAM).
- primary is not null and not equal to 0 or 1 (_ERR_CMD_INVALID_PARAM).
- publishPhone1, publishPhone2, and packageSupression is not null and not an integer (_ERR_CMD_INVALID_PARAM).
Field Summary |
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
NAME
|
Method Summary |
void |
setAddressId(java.lang.String astrAddressId)
Sets the address Id. |
COPYRIGHT
public static final java.lang.String COPYRIGHT
NAME
public static final java.lang.String NAME
setAddressId
public void setAddressId(java.lang.String astrAddressId)
- Sets the address Id.
- Parameters:
astrAddressId
- the address Id