com.ibm.commerce.collaboration.workspaces.commands
Class RemoveMemberFromSpaceCtrlCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.tools.command.ToolsControllerCommandImpl
|
+--com.ibm.commerce.collaboration.workspaces.commands.RemoveMemberFromSpaceCtrlCmdImpl
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, RemoveMemberFromSpaceCtrlCmd, ToolsControllerCommand
- public class RemoveMemberFromSpaceCtrlCmdImpl
- extends ToolsControllerCommandImpl
- implements RemoveMemberFromSpaceCtrlCmd
Removes a list of members from the collaborative workspace.
Behaviour
The command does the following for each member to be removed from the collaborative workspace:
- 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.
- Creates an instance of the CollabManagerAccessBean.
- Calls the deleteXXXGroupMember method in the access bean to remove the member from the collaborative workspace
where XXX is the role assigned to the member.
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.
Method Summary |
java.lang.String |
getCollabSpaceId()
Gets the unique identifier associated with the collaborative workspace. |
java.lang.String[] |
getRemoveMembers()
Gets a list of members to be removed from the collaborative workspace in the form of a vector. |
AccessVector |
getResources()
Gets the access control resources corresponding to the command. |
void |
performExecute()
Contains the business logic for the command. |
void |
setCollabSpaceId(java.lang.String newCollabSpaceId)
Sets the unique identifier associated with the collaborative workspace to a local variable. |
void |
setRemoveMembers(java.lang.String[] newRemoveMembers)
Sets the list of members to be removed from the collaborative workspace to a local variable. |
void |
setRequestProperties(TypedProperty reqParms)
Gets the input parameters from the requestProperties object and sets each parameter to a local variable. |
void |
validateParameters()
Validates that the syntax of the input parameters are correct. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties |
Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
accessControlCheck, checkIsAllowed, checkResourcePermission, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties |
CLASSNAME
public static final java.lang.String CLASSNAME
COPYRIGHT
public static final java.lang.String COPYRIGHT
RemoveMemberFromSpaceCtrlCmdImpl
public RemoveMemberFromSpaceCtrlCmdImpl()
getCollabSpaceId
public java.lang.String getCollabSpaceId()
- Gets the unique identifier associated with the collaborative workspace.
- Returns:
- The collaborative workspace Id.
getRemoveMembers
public java.lang.String[] getRemoveMembers()
- Gets a list of members to be removed from the collaborative workspace in the form of a vector.
- Returns:
- The list of members to be removed from the collaborative workspace.
getResources
public AccessVector getResources()
throws ECException
- Gets the access control resources corresponding to the command.
- Specified by:
getResources
in interface ECCommand
- Overrides:
getResources
in class AbstractECTargetableCommand
- Returns:
- The access vector associated with the command.
- Throws:
ECException
- If the access control resources cannot be retrieved.
performExecute
public void performExecute()
throws ECException
- Contains the business logic for the command.
- Specified by:
performExecute
in interface ECCommand
- Overrides:
performExecute
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
com.ibm.commerce.command.CommandException
- The superclass for all ECExceptions.
setCollabSpaceId
public void setCollabSpaceId(java.lang.String newCollabSpaceId)
- Sets the unique identifier associated with the collaborative workspace to a local variable.
- Parameters:
newCollabSpaceId
- The collaborative workspace Id.
setRemoveMembers
public void setRemoveMembers(java.lang.String[] newRemoveMembers)
- Sets the list of members to be removed from the collaborative workspace to a local variable.
- Parameters:
newRemovedMembers
- The list of members to be removed from the collaborative workspace.
setRequestProperties
public void setRequestProperties(TypedProperty reqParms)
throws ECApplicationException
- Gets the input parameters from the requestProperties object and sets each parameter to a local variable.
- Specified by:
setRequestProperties
in interface ControllerCommand
- Overrides:
setRequestProperties
in class ToolsControllerCommandImpl
- Parameters:
reqParms
- The input parameters that are received by the command.- Throws:
ECApplicationException
- If the collaborative workspace Id is missing.
validateParameters
public void validateParameters()
throws ECException
- Validates that the syntax of the input parameters are correct.
- Specified by:
validateParameters
in interface ECCommand
- Overrides:
validateParameters
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
ECException.
-