com.ibm.commerce.collaboration.workspaces.commands
Interface AddMemberToSpaceCtrlCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
AddMemberToSpaceCtrlCmdImpl

public interface AddMemberToSpaceCtrlCmd
extends ToolsControllerCommand

Adds a registered member to the collaborative workspace. The member will be automatically assigned the Author role in the collaborative workspace.

Behaviour

The command does the following for each member to be added to the collaborative workspace:

  1. Verifies that the user requesting the action has a Manager role in the collaborative workspace or a Site Administrator role in the seller organization. Otherwise, the requester does not have the authority to execute this command.
  2. Checks to make sure this member does not already have a role in the collaborative workspace. A member may have only one role in a collaborative workspace.
  3. Creates an instance of the CollabManagerAccessBean.
  4. Calls the addAuthorGroupMember method in the access bean to add the member to the collaborative workspace.
  5. If the member is added successfully and the sendEmail parameter is set to TRUE, the command will send an email notification to the new member specifying the URL to access the collaborative workspace. Email notification is sent only if both the receiver and the sender have registered e-mail addresses.

Exception Conditions

If the collaborative workspace Id parameter is missing, the command sets the _ERR_MISSING_CMD_PARAMETER exception task to handle the error.

If the user requester does not have the authority to execute the AddMember function, the command sets the EC_ERROR_COLLAB_NO_AUTHORIZATION exception task to handle the error.

If any member in the list of members being added to the collaborative workspace already has the Author role in the specified workspace, the command sets the EC_ERROR_MEMBER_HAS_ROLE exception task to handle the error.

If any member in the list of members being added to the collaborative workspace already has the Manager or Reader role in the specified workspace, the command sets the EC_ERROR_MEMBER_HAS_ANOTHER_ROLE exception task to handle the error.

If the AddMember action was not executed successfully, the command sets the EC_ERROR_ADD_MEMBERS exception task to handle the error.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmdImpl"
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmd".
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class is "com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmdImpl"

NAME

public static final java.lang.String NAME
The name of this interface is "com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmd".