com.ibm.commerce.catalogmanagement.commands
Interface CatalogEntryDeleteCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- CatalogEntryDeleteCmdImpl
- public interface CatalogEntryDeleteCmd
- extends ControllerCommand
Command Name: CatalogEntryDelete
Command Type: URL and Controller Command
Description: 1. If the force option is set to 1, then the Catalog Entry is deleted,
else the Catalog Entry is set to MarkForDelete.
2. If the Catalog Entry is a Product, then all its Product Attributes, Attribute Values, and Items will also be deleted or MarkForDelete.
3. All description tables are cascade deleted.
4. If the Catalog Entry being deleted is the last Catalog Entry associated with the inventory related tables,
these inventory tables are MarkedForDelete, regardless of the force option
5. If the Catalog Entry exists in Order Item, and the force option is set to 1,
then an exception will be thrown.
Parameters: 1. Catalog Entry Id or Partnumber for the Catalog Entry
2. No fields required.
3. No fields required
4. No fields required.
5. No fields required.
Tables: 1. CatEntry
2. Attribute, AttrValue, CatEntry
3. CatEntDesc, BaseItmDsc
4. BaseItem, ItemSpc, ItemVersn, VersionSpc
Task Commands: DeleteCatalogEntryCmd
Other Controller Commands: None
Mandatory Parameters: catentryId, or partnumber
Additional Parameters:
Optional Parameters: force
Method Summary |
java.lang.Long |
getCatentryId()
Get the catalog entry Id |
java.lang.String |
getPartnumber()
Get the partnumber of the catalog entry |
void |
setCatentryId(java.lang.Long anCatentryId)
Set a catalog entry Id |
void |
setForce(java.lang.Integer anForce)
Set the force delete option for the catalog entry
0 = catalog entry will be marked for delete
1 = catalog entry will be force deleted |
void |
setMarkfordelete(java.lang.Integer anMarkfordelete)
Set the mark for delete flag of the catalog entry
0 = catalog entry not marked for delete
1 = catalog entry marked for delete |
void |
setMemberId(java.lang.Long anMemberId)
Set the owner Id of the catalog entry |
void |
setPartnumber(java.lang.String astrPartnumber)
Set the force delete option for the catalog entry |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters |
CLASSNAME
public static final java.lang.String CLASSNAME
COPYRIGHT
public static final java.lang.String COPYRIGHT
getCatentryId
public java.lang.Long getCatentryId()
- Get the catalog entry Id
- Returns:
- java.lang.Long
getPartnumber
public java.lang.String getPartnumber()
- Get the partnumber of the catalog entry
- Returns:
- java.lang.String
setCatentryId
public void setCatentryId(java.lang.Long anCatentryId)
- Set a catalog entry Id
- Parameters:
anCatentryId
- java.lang.Long
setForce
public void setForce(java.lang.Integer anForce)
- Set the force delete option for the catalog entry
0 = catalog entry will be marked for delete
1 = catalog entry will be force deleted
- Parameters:
anForce
- java.lang.Integer
setMarkfordelete
public void setMarkfordelete(java.lang.Integer anMarkfordelete)
- Set the mark for delete flag of the catalog entry
0 = catalog entry not marked for delete
1 = catalog entry marked for delete
- Parameters:
anMarkfordelete
- java.lang.Integer
setMemberId
public void setMemberId(java.lang.Long anMemberId)
- Set the owner Id of the catalog entry
- Parameters:
anMemberId
- java.lang.Long
setPartnumber
public void setPartnumber(java.lang.String astrPartnumber)
- Set the force delete option for the catalog entry
- Parameters:
astrPartnumber
- java.lang.String