com.ibm.commerce.messaging.commands
Class DeleteMsgFromStorageCmdImpl

java.lang.Object
  |
  +--MessagingAdminCmd
        |
        +--com.ibm.commerce.messaging.commands.DeleteMsgFromStorageCmdImpl
All Implemented Interfaces:
AccCommand, ControllerCommand, DeleteMsgFromStorageCmd, ECCommand, ToolsControllerCommand

public class DeleteMsgFromStorageCmdImpl
extends MessagingAdminCmd
implements DeleteMsgFromStorageCmd

This is the default implementation of DeleteMsgFromStorageCmd.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
          IBM copyright field
 
Fields inherited from interface com.ibm.commerce.messaging.commands. DeleteMsgFromStorageCmd
defaultCommandClassName, NAME
 
Constructor Summary
DeleteMsgFromStorageCmdImpl()
          DeleteMsgFromStorageCmdImpl cosntructor
 
Method Summary
 boolean isGeneric()
          Check to see if this is a generic command.
 boolean isReadyToCallExecute()
          Check to see if the command is ready to execute.
 boolean isRetriable()
          Check to see if this command is retriable on errors like rollback exception
 void performExecute()
          The business logic for this controller command.
 void validateParameters()
          ControllerCommandImpl calls checkParameter in performExecute.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, 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, mergeProperties, setGeneric, setRequestProperties, 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, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright field
See Also:
Constant Field Values
Constructor Detail

DeleteMsgFromStorageCmdImpl

public DeleteMsgFromStorageCmdImpl()
DeleteMsgFromStorageCmdImpl cosntructor
Method Detail

isGeneric

public boolean isGeneric()
Check to see if this is a generic command. A generic command can be called by a generic user. The default is false.
Specified by:
isGeneric in interface ControllerCommand
Returns:
boolean True if this command can be called by a generic user; false otherwise

isReadyToCallExecute

public boolean isReadyToCallExecute()
Check to see if the command is ready to execute.
Returns:
Always true.

isRetriable

public boolean isRetriable()
Check to see if this command is retriable on errors like rollback exception
Specified by:
isRetriable in interface ControllerCommand
Returns:
boolean True if this command is retriabl; false otherwise.

performExecute

public void performExecute()
                    throws ECException
The business logic for this controller command. For this default implementation we simply calls checkParameters. Command writers who overwrites this method should do a super() as the first line in their method if they want checkParameters to be called.
Specified by:
performExecute in interface ECCommand
Throws:
ECException - The exception description.

validateParameters

public void validateParameters()
                        throws ECException
ControllerCommandImpl calls checkParameter in performExecute. It is the responsibility of the command writers to implements this method if they want to perform server side parameter checking. They should either calls checkParameters inside their performExecute or calls super.performExecute() as the first statement in the performExecute method.
Specified by:
validateParameters in interface ECCommand
Throws:
CommandException.
ECException