com.ibm.commerce.usermanagement.commands
Interface OrgEntityAddCmd
- All Known Implementing Classes:
- OrgEntityAddCmdImpl
- public interface OrgEntityAddCmd
This command registers a new organization or organizational unit.
The information of the new organization or organizational unit is stored in the MEMBER, ORGENTITY, MBRREL
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 parameter URL, orgEntityName, orgEntityType and parentMemberId are
mandatory. The rest of the parameters are all optional.
Behavior
- Calls an empty task command PreOrgEntityAddCmd. Store Developers can overwrite it change the input to the command.
- Check the required parameters.
- Calls a task command SetBusinessEntityCmd to set the BusinessEntity attribute.
- Calls a task command AuditOrgEntityCmd to perform additional parameter checking.
Store Developers need to add new code to AuditAddressCmd task command if they want to customize the check.
- If any field related to ADDRESS table is specified, a self address (also called register address, with
selfAddress field set to '1' and nickname is same as orgEntityName) will be created. Otherwise no record will be created in
the ADDRESS table.
- If the command fails, the OrgEntityErrorView view command is called. Upon successful completion, the specified URL is called.
- Calls an empty task command PostOrgEntityAddCmd. 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).
- parentMemberId is null (_ERR_CMD_MISSING_PARAM).
- parentMemberId is not a foreign key set to the ORGENTITY table (_ERR_CMD_INVALID_PARAM).
- orgEntityName is null (_ERR_CMD_MISSING_PARAM).
- The length of orgEntityName equals 0 (_ERR_CMD_INVALID_PARAM).
- orgEntityType is null (_ERR_CMD_MISSING_PARAM).
- orgEntityType is not 'O' or 'OU' (_ERR_CMD_INVALID_PARAM).
- In LDAP Mode, the formulated Distinguished Name already exist in LDAP Sever or WCS Database (_ERR_RDN_ALREADY_EXIST).
- In LDAP Mode, the distinguishedName specified already exist in LDAP Sever or WCS Database (_ERR_DN_ALREADY_EXIST).
Field Summary |
static java.lang.String |
COPYRIGHT
|
static java.lang.String |
NAME
|
COPYRIGHT
public static final java.lang.String COPYRIGHT
NAME
public static final java.lang.String NAME