CancelWorkspaceCmd

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

CancelWorkspaceCmdImpl
```
public interface CancelWorkspaceCmd
extends TaskCommand
```
The CancelWorkspaceCmd is a task command that:
- Changes the Workspace status to Cancelled
- Releases the Workspace back to the pool
Parameters:
- workspaceId
Access Beans:
Mandatory Parameters: workspaceId
Additional Parameters: none
Optional Parameters: none

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASSNAME
Define the CLASSNAME.

static java.lang.String COPYRIGHT
The internal copyright field.
- Fields inherited from interface com.ibm.commerce.command.CacheableECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getWorkspaceId()` Returns the Workspace ID.
`void`	`setWorkspaceId(java.lang.Long anWorkspaceId)` Sets the Workspace ID.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand
execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command
isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller
unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    The internal copyright field.
    
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
static final java.lang.String CLASSNAME
```
    Define the CLASSNAME.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getWorkspaceId
```
java.lang.Long getWorkspaceId()
```
    Returns the Workspace ID.
    
    Returns:
    
    The unique ID of the Workspace.
  - setWorkspaceId
```
void setWorkspaceId(java.lang.Long anWorkspaceId)
```
    Sets the Workspace ID.
    
    Parameters:
    
    anWorkspaceId - the unique ID of the Workspace.