com.ibm.commerce.interestitems.commands
Class InterestItemListDeleteCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.interestitems.commands.InterestItemListDeleteCmdImpl
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, InterestItemListDeleteCmd, Protectable
- public class InterestItemListDeleteCmdImpl
- extends ControllerCommandImpl
- implements InterestItemListDeleteCmd
The InterestItemListDelete deletes the specified interest item lists
and all items in them.
Field Summary |
static java.lang.String |
CLASSNAME
The fully qualified name of this class. |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
Method Summary |
AccessVector |
getResources()
Gets the access vector accessed by this command. |
boolean |
isReadyToCallExecute()
isReadyToCallExecute method is called by the Targettable Command frame work
before the execution of the command. |
void |
performExecute()
Contains the actual business logic of the command
It should be implemented by all the command writer. |
void |
reset()
This method should be called after a command has been executed to reset its states variables. |
void |
setListId(java.lang.String[] asaListId)
Specifies zero or more interest item lists to be deleted. |
void |
setListIdName(java.lang.String[] asaListIdName)
Specifies the names of name-value pairs to be added to the redirection
URL. |
void |
setRequestProperties(TypedProperty aRequestProperties)
The WebController calls this method before invoking the execute method in this command to
set the request properties for this command. |
void |
validateParameters()
Performs server side parameter checking. |
Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl |
fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, 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, 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
- The fully qualified name of this class.
COPYRIGHT
public static final java.lang.String COPYRIGHT
- The internal copyright field.
InterestItemListDeleteCmdImpl
public InterestItemListDeleteCmdImpl()
- No value constructor.
getResources
public AccessVector getResources()
throws ECException
- Description copied from interface:
ECCommand
- Gets the access vector accessed by this command.
The default implementation returns null indicating that no protectable resource is
accessed by this command. It is the responsibilities of the command writer to
return the protectable primary resource(s) and the corresponding actions accessed
by this command.
- Specified by:
getResources
in interface ECCommand
- Overrides:
getResources
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Returns:
- AccessVector - a vector of resource action pairs
isReadyToCallExecute
public boolean isReadyToCallExecute()
- Description copied from class:
AbstractECTargetableCommand
- isReadyToCallExecute method is called by the Targettable Command frame work
before the execution of the command. The default implementation is to return true.
- Overrides:
isReadyToCallExecute
in class AbstractECTargetableCommand
- Following copied from class:
com.ibm.commerce.command.AbstractECTargetableCommand
- Returns:
- boolean - true if we can execute the command
false if we canot execute the command
performExecute
public void performExecute()
throws ECException
- Description copied from interface:
ECCommand
- Contains the actual business logic of the command
It should be implemented by all the command writer.
- 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.
reset
public void reset()
- Description copied from class:
AbstractECTargetableCommand
- This method should be called after a command has been executed to reset its states variables.
After the call to reset, we should be able to execute the command again.
- Overrides:
reset
in class AbstractECTargetableCommand
setListId
public void setListId(java.lang.String[] asaListId)
- Specifies zero or more interest item lists to be deleted.
In addition to interest item list reference numbers it can be
specified as one of the special abbreviations ".", "*".
If "." is specified, the GetCurrentIILists process task is
invoked to obtain the shopper's current interest item lists,
and the command behaves as if the current interest item lists
were specified. If GetCurrentIILists process task determines
that there are no current interest item lists, the most recently
updated item interest item list is used.
If "*" is specified, the command behaves as if all shopper's
interest item lists were specified.
If a specified interest item list no longer exist, it is not deleted.
- Specified by:
setListId
in interface InterestItemListDeleteCmd
- Parameters:
asaListId
- the ListId
setListIdName
public void setListIdName(java.lang.String[] asaListIdName)
- Specifies the names of name-value pairs to be added to the redirection
URL. The values of the added name-value pairs are the reference
numbers of the interest lists specified by ListId. This is provided
to make it possible to obtain the reference numbers of the interest
lists when ListId is not explicitly specified.
- Specified by:
setListIdName
in interface InterestItemListDeleteCmd
- Parameters:
asaListIdName
- the array of names
setRequestProperties
public void setRequestProperties(TypedProperty aRequestProperties)
throws ECApplicationException
- Description copied from interface:
ControllerCommand
- The WebController calls this method before invoking the execute method in this command to
set the request properties for this command.
It is the responsibility of the implementer of the ControllerCommand to extract the
required input parameters from the request properties and perform parameter checking.
- Specified by:
setRequestProperties
in interface ControllerCommand
- Overrides:
setRequestProperties
in class ControllerCommandImpl
- Following copied from interface:
com.ibm.commerce.command.ControllerCommand
- Parameters:
requestProperties
- com.ibm.commerce.datatype.TypedProperty- Throws:
com.ibm.commerce.exception.ECException.
-
validateParameters
public void validateParameters()
throws ECException
- Description copied from interface:
ECCommand
- Performs server side parameter checking. This method replaces the checkParameters() method in a previous
version of the code.
- Specified by:
validateParameters
in interface ECCommand
- Overrides:
validateParameters
in class AbstractECTargetableCommand
- Following copied from interface:
com.ibm.commerce.command.ECCommand
- Throws:
ECException.
-