java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.ControllerCommandImpl | +--com.ibm.commerce.tools.command.ToolsControllerCommandImpl | +--com.ibm.commerce.collaboration.workspaces.commands.CreateSpaceCtrlCmdImpl
Creates a new collaborative workspace. The QuickPlace associated with the collaborative workspace will be created on the QuickPlace server, and the corresponding LDAP entries will be created in the LDAP directory.
Behaviour
The command does the following:
Exception Conditions
If the collaborative workspace name or template name parameters are missing, the command sets the _ERR_MISSING_CMD_PARAMETER exception task to handle the error.
If the collaborative workspace cannot be created due to an LDAP error, the command sets the EC_ERROR_LDAP_DOWN exception task to handle the error.
If the collaborative workspace cannot be created due to a QuickPlace server error, the command sets the EC_ERROR_QP_DOWN exception task to handle the error.
Field Summary | |
---|---|
static java.lang.String |
COPYRIGHT Copyright statement |
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. CreateSpaceCtrlCmd |
defaultCommandClassName,
NAME |
Constructor Summary | |
---|---|
CreateSpaceCtrlCmdImpl() |
Method Summary | |
---|---|
protected
int |
generateANumber() Generates a random string of numbers. |
protected
java.lang.String |
generateCollabWorkspaceId() Generates a unique collaborative workspace ID based on the date of creation and a random string of numbers. |
java.lang.String |
getAccountId() Gets the unique identifier of the account associated with the collaborative workspace. |
java.lang.String |
getCollabSpaceDescription() Gets the description of the collaborative workspace. |
java.lang.String |
getCollabSpaceName() Gets the name of the collaborative workspace. |
java.lang.String |
getProcessId() Gets the unique identifier of the process associated with the collaborative workspace. |
java.lang.String |
getProcessType() Gets the process type of the collaborative workspace. |
AccessVector |
getResources() Gets the access control resources corresponding to the command. |
java.lang.String |
getTemplateName() Gets the name of the QuickPlace template that will be used to create the collaborative workspace. |
void |
performExecute() Contains the business logic for the command. |
void |
setAccountId(java.lang.String newAccountId) Sets the unique identifier of the account associated with the collaborative workspace to a local variable. |
void |
setCollabSpaceDescription(java.lang.String newCollabSpaceDescription) Sets the description of the collaborative workspace to a local variable. |
void |
setCollabSpaceName(java.lang.String newCollabSpaceName) Sets the name of the collaborative workspace to a local variable. |
void |
setProcessId(java.lang.String newProcessId) Sets the unique identifier of the process associated with the collaborative workspace to a local variable. |
void |
setProcessType(java.lang.String newProcessType) Sets the process type associated with the collaborative workspace ID. |
void |
setRequestProperties(
TypedProperty reqParms) Gets the input parameters from the requestProperties object and sets each parameter to a local variable. |
void |
setTemplateName(java.lang.String newTemplateName) Sets the name of the QuickPlace template that will be used to create the collaborative workspace. |
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 |
checkPermission,
fulfills,
getForUserId,
getGeneric,
getOwner,
getRequestProperties,
getResolvedRequestProperties,
getResourceOwners,
getResponseProperties,
getRetriable,
isGeneric,
isRetriable,
mergeProperties,
setForUserId,
setGeneric,
setOwner,
setResponseProperties,
setRetriable,
setViewInputProperties |
Methods inherited from class com.ibm.commerce.command. AbstractECTargetableCommand |
accessControlCheck,
checkIsAllowed,
checkParameters,
checkResourcePermission,
createCommandExecutionEvent,
execute,
finalize,
getAccCheck,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
isReadyToCallExecute,
reset,
setAccCheck,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Methods inherited from class java.lang.Object |
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait,
wait, wait |
Methods inherited from interface com.ibm.commerce.command. ControllerCommand |
checkPermission,
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,
getResourceOwners,
setAccCheck,
setForUserId,
setOwner |
Methods inherited from interface com.ibm.commerce.command. ECCommand |
checkIsAllowed,
checkResourcePermission,
createCommandExecutionEvent,
getCommandContext,
getCommandIfName,
getCommandName,
getCommandStoreId,
getDefaultProperties,
getStoreId,
getUser,
getUserId,
setCommandContext,
setCommandIfName,
setCommandStoreId,
setDefaultProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
Constructor Detail |
---|
public CreateSpaceCtrlCmdImpl()
Method Detail |
---|
protected int generateANumber()
protected java.lang.String generateCollabWorkspaceId()
public java.lang.String getAccountId()
public java.lang.String getCollabSpaceDescription()
public java.lang.String getCollabSpaceName()
public java.lang.String getProcessId()
public java.lang.String getProcessType()
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 getTemplateName()
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
java.lang.Exception
- thrown by WebSphereCommerce serverECException
public void setAccountId(java.lang.String newAccountId)
newAccountId
- The account Id associated with the
collaborative workspace.public void setCollabSpaceDescription(java.lang.String newCollabSpaceDescription)
newCollabSpaceDescription
- The description of the
collaborative workspace.public void setCollabSpaceName(java.lang.String newCollabSpaceName)
newCollabSpaceName
- The name of the collaborative
workspace.public void setProcessId(java.lang.String newProcessId)
newProcessId
- The process Id of the collaborative
workspace.public void setProcessType(java.lang.String newProcessType)
newProcessType
- The process type of the collaborative
workspace.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 setTemplateName(java.lang.String newTemplateName)
newTemplateName
- The name of the QuickPlace
template.public void validateParameters() throws ECException
validateParameters
in interface
ECCommand
validateParameters
in class
AbstractECTargetableCommand
Exceptions
- thrown by WebSphereCommerce serverECException