com.ibm.commerce.productset.commands
Class ProductSetDeleteCmdImpl
com.ibm.commerce.command.AbstractECTargetableCommand
|
+--com.ibm.commerce.command.ControllerCommandImpl
|
+--com.ibm.commerce.productset.commands.ProductSetDeleteCmdImpl
- All Implemented Interfaces:
- AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, ProductSetDeleteCmd, Protectable
- public class ProductSetDeleteCmdImpl
- extends ControllerCommandImpl
- implements ProductSetDeleteCmd
Deletes a product set definition based on the input prodcut set ID.
Input parameters:
Name | Type | Requirement | Description |
productSetID | Integer | mandatory | The product set ID. |
markForDeleteOnly | String | optional | When input is "yes", only mark delete the product set. |
Output parameters:
Name | Type | Description |
productSetId | Integer | The deleted product set's ID. |
productSetName | String | The deleted product set's name. |
memberId | Long | The deleted product set's member ID. |
Behavior:
- Delete the product set's definition based on the input product set ID.
- If the input parameter markForDelete is set to "yes", only mark delete the product set's definition.
Exception:
- Throws an ECApplicationException with the message key _ERR_ENTITY_OBJECT_NOT_FOUND, if can not find the product set.
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 |
java.lang.String |
getMarkForDelete()
Returns the mark for delete flag that indicate whether this product set should be deleted or marked for delete. |
java.lang.Long |
getMemberId()
Returns the MemberId that represents the primary key of the owner of the product set. |
java.lang.Integer |
getProductSetId()
Returns the ProductSetId that represents the primary key of the product set. |
java.lang.String |
getProductSetName()
Returns the name of the product set. |
AccessVector |
getResources()
Gets the access vector accessed by this command. |
void |
performExecute()
Contains the actual business logic of the command
It should be implemented by all the command writer. |
void |
setMarkForDelete(java.lang.String newMarkForDelete)
Sets the mark for delete flag to indicate whether this product set should be deleted or marked for delete. |
void |
setMemberId(java.lang.Long newPsMemberId)
Sets the MemberId that represents the primary key of the owner of the product set. |
void |
setProductSetId(java.lang.Integer newPsId)
Sets the ProductSetId that represents the primary key of the product set. |
void |
setProductSetName(java.lang.String newPsName)
Sets the Name of the product set. |
void |
setRequestProperties(TypedProperty reqParms)
The WebController calls this method before invoking the execute method in this command to
set the request properties for this command. |
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, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
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, validateParameters |
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.
ProductSetDeleteCmdImpl
public ProductSetDeleteCmdImpl()
- No value constructor.
getMarkForDelete
public java.lang.String getMarkForDelete()
- Returns the mark for delete flag that indicate whether this product set should be deleted or marked for delete.
- Returns:
- java.lang.String
getMemberId
public java.lang.Long getMemberId()
- Description copied from interface:
ProductSetDeleteCmd
- Returns the MemberId that represents the primary key of the owner of the product set.
- Specified by:
getMemberId
in interface ProductSetDeleteCmd
- Following copied from interface:
com.ibm.commerce.productset.commands.ProductSetDeleteCmd
- Returns:
- java.lang.Long
getProductSetId
public java.lang.Integer getProductSetId()
- Description copied from interface:
ProductSetDeleteCmd
- Returns the ProductSetId that represents the primary key of the product set.
- Specified by:
getProductSetId
in interface ProductSetDeleteCmd
- Following copied from interface:
com.ibm.commerce.productset.commands.ProductSetDeleteCmd
- Returns:
- java.lang.Integer
getProductSetName
public java.lang.String getProductSetName()
- Description copied from interface:
ProductSetDeleteCmd
- Returns the name of the product set.
- Specified by:
getProductSetName
in interface ProductSetDeleteCmd
- Following copied from interface:
com.ibm.commerce.productset.commands.ProductSetDeleteCmd
- Returns:
- java.lang.String
getResources
public AccessVector getResources()
throws ECException
- 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 on the resource.
- Specified by:
getResources
in interface ECCommand
- Overrides:
getResources
in class AbstractECTargetableCommand
- Returns:
- AccessVector - a vector of resource action pairs
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.
setMarkForDelete
public void setMarkForDelete(java.lang.String newMarkForDelete)
- Description copied from interface:
ProductSetDeleteCmd
- Sets the mark for delete flag to indicate whether this product set should be deleted or marked for delete.
- Specified by:
setMarkForDelete
in interface ProductSetDeleteCmd
- Following copied from interface:
com.ibm.commerce.productset.commands.ProductSetDeleteCmd
- Parameters:
newMarkForDelete
- java.lang.String
setMemberId
public void setMemberId(java.lang.Long newPsMemberId)
- Sets the MemberId that represents the primary key of the owner of the product set.
- Parameters:
newPsMemberId
- java.lang.Long
setProductSetId
public void setProductSetId(java.lang.Integer newPsId)
- Description copied from interface:
ProductSetDeleteCmd
- Sets the ProductSetId that represents the primary key of the product set.
- Specified by:
setProductSetId
in interface ProductSetDeleteCmd
- Following copied from interface:
com.ibm.commerce.productset.commands.ProductSetDeleteCmd
- Parameters:
new
- PsId java.lang.Integer
setProductSetName
public void setProductSetName(java.lang.String newPsName)
- Sets the Name of the product set.
- Parameters:
newPsName
- java.lang.String
setRequestProperties
public void setRequestProperties(TypedProperty reqParms)
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.
-