|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl | +--com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmdImpl
Adds a list of registered members to the collaborative workspace. Each 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:
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 |
CLASSNAME
|
static java.lang.String |
COPYRIGHT
|
Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl |
requestProperties, responseProperties, retriable, viewReqProperties |
Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand |
commandContext |
Fields inherited from interface com.ibm.commerce.collaboration.workspaces.commands.AddMemberToSpaceCtrlCmd |
defaultCommandClassName, NAME |
Constructor Summary | |
AddMemberToSpaceCtrlCmdImpl()
|
Method Summary | |
java.lang.String |
getCollabSpaceId()
Gets the unique identifier associated with the collaborative workspace. |
java.lang.String |
getCSCreator()
Gets the national language-specific name of the creator of the collaborative workspace based on the language Id in the command context. |
java.lang.String |
getCSName()
Gets the name of the collaborative workspace. |
java.lang.String |
getEmailAddressForUser(java.lang.String user)
Gets the email address associated with a given user DN (Distinguished Name). |
java.lang.String |
getLanguageIdForUser(java.lang.String user)
Gets the preferred language Id of the users. |
java.util.Vector |
getNewMembers()
Gets a list of members to be added to the collaborative workspace in the form of a vector. |
java.lang.String |
getQuickPlaceURL()
Gets the URL to the controller command that will redirect to the QuickPlace associated with a collaborative workspace. |
AccessVector |
getResources()
Gets the access control resources corresponding to the command. |
java.lang.String |
getWCUserId(java.lang.String fullDN)
Gets the logon Id of a user from the full Distinguished Name. |
void |
performExecute()
Contains the business logic for the command. |
boolean |
sendEmail(java.lang.String senderEmailAddress,
java.lang.String receiverEmailAddress,
java.lang.String csName,
java.lang.String csCreator,
java.lang.String quickPlaceURL,
java.lang.String wcUserId,
java.lang.String languageId)
Sends an email notification to the new member in the collaborative workspace specifying the URL to access the collaborative workspace. |
void |
setCollabSpaceId(java.lang.String newCollabSpaceId)
Sets the unique identifier associated with the collaborative workspace to a local variable. |
void |
setNewMembers(java.util.Vector newMembers)
Sets the list of new members to be added to 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 |
setSendEmail(boolean newSendEmail)
Sets the parameter specifying whether email notification should be sent to the new member. |
boolean |
shouldSendEmail()
Gets the parameter specifying whether email notification should be sent to the new member. |
void |
validateParameters()
Validates that the syntax of the input parameters are correct. |
Methods inherited from class com.ibm.commerce.tools.command.ToolsControllerCommandImpl |
getViewInputProperties |
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.AccCommand |
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setDefaultProperties |
Methods inherited from interface com.ibm.commerce.security.Protectable |
fulfills, getOwner |
Field Detail |
public static final java.lang.String CLASSNAME
public static final java.lang.String COPYRIGHT
Constructor Detail |
public AddMemberToSpaceCtrlCmdImpl()
Method Detail |
public java.lang.String getCollabSpaceId()
public java.lang.String getCSCreator()
public java.lang.String getCSName()
public java.lang.String getEmailAddressForUser(java.lang.String user)
user
- The distinguished name of a user (ex. uid=demoUser,o=Root Organization)public java.lang.String getLanguageIdForUser(java.lang.String user)
user
- The collaborative workspace user.public java.util.Vector getNewMembers()
public java.lang.String getQuickPlaceURL()
public AccessVector getResources() throws ECException
getResources
in interface ECCommand
getResources
in class AbstractECTargetableCommand
ECException
- If the access control resources cannot be retrieved.public java.lang.String getWCUserId(java.lang.String fullDN)
public void performExecute() throws ECException
performExecute
in interface ECCommand
performExecute
in class AbstractECTargetableCommand
com.ibm.commerce.command.ECCommand
com.ibm.commerce.command.CommandException
- The superclass for all ECExceptions.public boolean sendEmail(java.lang.String senderEmailAddress, java.lang.String receiverEmailAddress, java.lang.String csName, java.lang.String csCreator, java.lang.String quickPlaceURL, java.lang.String wcUserId, java.lang.String languageId) throws ECException
senderEmailAddress
- The email address of the sender.receiverEmailAddress
- The email address of the receiver.csName
- The name of the collaborative workspace.csCreator
- The name of the creator of the collaborative workspace.quickPlaceURL
- The URL of the QuickPlace associated with the collaborative workspace.wcUserId
- The logon Id of the new member in the collaborative workspace.languageId
- The preferred language Id of the receiver of the email.public void setCollabSpaceId(java.lang.String newCollabSpaceId)
newCollabSpaceId
- The collaborative workspace Id.public void setNewMembers(java.util.Vector newMembers)
newMembers
- The list of new members.public void setRequestProperties(TypedProperty reqParms) throws ECApplicationException
setRequestProperties
in interface ControllerCommand
setRequestProperties
in class ToolsControllerCommandImpl
reqParms
- The input parameters that are received by the command.ECApplicationException
- If the collaborative workspace Id is missing.public void setSendEmail(boolean newSendEmail)
newSendEmail
- The variable specifying whether email should be sent.public boolean shouldSendEmail()
public void validateParameters() throws ECException
validateParameters
in interface ECCommand
validateParameters
in class AbstractECTargetableCommand
com.ibm.commerce.command.ECCommand
ECException.
-
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |