CatalogEntryDeleteCmd

All Superinterfaces:

AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand

All Known Implementing Classes:

CatalogEntryDeleteCmdImpl
```
public interface CatalogEntryDeleteCmd
extends ControllerCommand
```
The CatalogEntryDeleteCmd is a URL and controller command that:
- If the force option is set to 1, then the catalog entry is deleted, else the catalog entry is set to mark for delete.
- If the catalog entry is a product, then all its product attributes, attribute values, and items will be deleted or mark for delete.
- All description tables are cascade deleted.
- The force option does not apply to the inventory tables, for example, the baseitem and item specification tables. The baseitem and item specification will be marked for delete depending if the force option is set to 1 for delete and the check ATP option is set to true for checking.
- By default, the check ATP option is set to false (off).
  - If the check ATP option is set to true, then it will be checked whether or not the catalog entry being deleted is the last catalog entry associated with the baseitem or item specification. If the catalog entry is the last one associated with them, then the baseitem or item specification will be mark for deleted, regardless of the force option. The force option is only applicable to the catalog entry, not the inventory.
  - If the check ATP option is set to false, then no checking on the ivnetory will be performed. The partnumber of the baseitem or item specification associated with the catalog entry will be appended a timestamp. They will not be deleted or marked for delete.
- If the catalog entry exists in an order item, and the force option is set to 1, then an exception will be thrown.
- If the Catalog Entry ID is supplied, then the partnumber will be ignored.
Parameters:
- Catalog entry ID or partnumber of the catalog entry.
- No fields required.
- No fields required.
- Force option required.
- Check ATP option required.
Access Beans:
- CatalogEntryAccessBean
- AttributeAccessBean, AttributeValueAccessBean, CatalogEntryAccessBean
- CatalogEntryDescriptionAccessBean, BaseItmDescriptionAccessBean
- BaseItemAccessBean, ItemSpecificationAccessBean
- BaseItemAccessBean, ItemSpecificationAccessBean
Task Commands: DeleteCatalogEntryCmd
Other Controller Commands: None
Mandatory Parameters: catentryId, or partnumber.
Additional Parameters: none
Optional Parameters: force, checkATP.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASSNAME` The name of this interface is "com.ibm.commerce.catalogmanagement.commands.CatalogEntryDeleteCmd".
`static java.lang.String`	`COPYRIGHT` The internal copyright field.

Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command
serialVersionUID

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getCatentryId()` Gets the catalog entry ID.
`java.lang.String`	`getPartnumber()` Gets the partnumber of the catalog entry.
`void`	`setCatentryId(java.lang.Long anCatentryId)` Sets the catalog entry ID.
`void`	`setCheckATP(java.lang.Boolean abCheckATP)` Sets the check ATP option for the delete command: True = BaseItem and ItemSpc will be checked.
`void`	`setForce(java.lang.Integer anForce)` Sets the force delete option for the catalog entry: 0 = catalog entry will be marked for delete.
`void`	`setMarkfordelete(java.lang.Integer anMarkfordelete)` Sets the mark for delete flag of the catalog entry: 0 = catalog entry not marked for delete.
`void`	`setMemberId(java.lang.Long anMemberId)` Sets the owner ID of the catalog entry.
`void`	`setPartnumber(java.lang.String astrPartnumber)` Sets the partnumber of the catalog entry.

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties

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.CommandCaller
unionDependencies

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, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner

- 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
```
    The name of this interface is "com.ibm.commerce.catalogmanagement.commands.CatalogEntryDeleteCmd".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getCatentryId
```
java.lang.Long getCatentryId()
```
    Gets the catalog entry ID.
    
    Returns:
    
    the catalog entry ID
  - getPartnumber
```
java.lang.String getPartnumber()
```
    Gets the partnumber of the catalog entry.
    
    Returns:
    
    the catalog entry partnumber
  - setCatentryId
```
void setCatentryId(java.lang.Long anCatentryId)
```
    Sets the catalog entry ID.
    
    Parameters:
    
    anCatentryId - the catalog entry ID
  - setCheckATP
```
void setCheckATP(java.lang.Boolean abCheckATP)
```
    Sets the check ATP option for the delete command:
    - True = BaseItem and ItemSpc will be checked.
    - False = BaseItem and ItemSpc will not be checked.
    By default, it is set to False.
    Parameters:
    
    abCheckATP - whether or not to check the baseitem and item specification when deleting the catalog entry
  - setForce
```
void setForce(java.lang.Integer anForce)
```
    Sets 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 - whether the catalog entry will be deleted or mark for deletion
  - setMarkfordelete
```
void setMarkfordelete(java.lang.Integer anMarkfordelete)
```
    Sets the mark for delete flag of the catalog entry:
    - 0 = catalog entry not marked for delete.
    - 1 = catalog entry marked for delete.
    Use the force option instead.
    Parameters:
    
    anMarkfordelete - mark for delete flag of the catalog entry
  - setMemberId
```
void setMemberId(java.lang.Long anMemberId)
```
    Sets the owner ID of the catalog entry.
    
    Parameters:
    
    anMemberId - the owner ID of the catalog entry
  - setPartnumber
```
void setPartnumber(java.lang.String astrPartnumber)
```
    Sets the partnumber of the catalog entry.
    
    Parameters:
    
    astrPartnumber - the partnumber of the catalog entry

Interface CatalogEntryDeleteCmd

Field Summary

Fields inherited from interface com.ibm.commerce.command.ECCommand

Fields inherited from interface com.ibm.websphere.command.Command

Method Summary

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

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

Methods inherited from interface com.ibm.commerce.command.AccCommand

Methods inherited from interface com.ibm.commerce.command.ECCommand

Methods inherited from interface com.ibm.websphere.command.Command

Methods inherited from interface com.ibm.commerce.security.Protectable

Field Detail

COPYRIGHT

CLASSNAME

Method Detail

getCatentryId

getPartnumber

setCatentryId

setCheckATP

setForce

setMarkfordelete

setMemberId

setPartnumber