CatalogEntryAttachmentDeleteCmdImpl

java.lang.Object
- MeasuredCacheableCommandImpl
- - com.ibm.commerce.command.AbstractECTargetableCommand
  - - com.ibm.commerce.command.ControllerCommandImpl
    - - com.ibm.commerce.attachment.commands.AttachmentRelationBaseDeleteCmdImpl
      - com.ibm.commerce.catalogattachment.commands.CatalogEntryAttachmentDeleteCmdImpl

All Implemented Interfaces:

AttachmentRelationBaseDeleteCmd, CatalogEntryAttachmentDeleteCmd, AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable
```
public class CatalogEntryAttachmentDeleteCmdImpl
extends AttachmentRelationBaseDeleteCmdImpl
implements CatalogEntryAttachmentDeleteCmd
```
This command will delete the catalog entry attachment relations with the specified parameters.
Parameters:
- atchrelId
- catentryId
- partnumber
- catentryId, atchrlusId, atchtgtId
- partnumber, atchrlusId, atchtgtId
Behavior:
- Delete by the attachment relation.
  - The delete by business object option is set to False
  - If the attachment relation ID is not specified, then the information about the attachment relation must be specified. These information includes the catalog entry ID, the attachment target ID, and the attachment relation usage ID. The catalog entry ID can be replaced by the part number of the catalog entry. These parameters will then be used to obtain the attachment relation ID. If the attachment relation ID cannot be found, an exception will be thrown.
  - Delete the corresponding attachment relation.
  - Delete the corresponding attachment relation descriptions.
- Delete all the attachment relations in a business object.
  - The delete by business object option is set to True or the following parameters are set to null:
    - atchrelId (the attachment relation id)
    - atchrlusId (the attachment relation usage id)
    - atchtgtId (the attachment target id)
  - The catentryId or part number must be specified, an exception will be thrown if any one of these parameters are missing.
  - Find all the attachment relation belongs to this catalog, and delete all the attachment relations found.
  - For all the attachment relations deleted, delete the corresponding attachment relation descriptions.
- By default, the delete by business object is set to False so it will delete only the specified attachment relation and relation descriptions.
- If the Catalog Entry Id (catentryId) is specified, the command will use the catentryId instead of the catalog entry part number. If catentryId is not specified, then the part number must be specified. The part number is used together with the member ID to obtain the Catalog Entry ID. The member ID is obtained as the owner of the store where the command is called.
Access Bean:
- AttachmentRelationAccessBean
Task Commands:
- DeleteAttachmentRelationCmd
Helper:
- AttachmentRelationHelper

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASSNAME
Define the CLASSNAME.

static java.lang.String COPYRIGHT
The internal copyright field.
- Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl
  requestProperties, responseProperties, retriable, viewReqProperties
- Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand
  commandContext
- Fields inherited from interface com.ibm.commerce.command.ECCommand
  defaultCommandClassName
- Fields inherited from interface com.ibm.websphere.command.Command
  serialVersionUID

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASSNAME` Define the CLASSNAME.
`static java.lang.String`	`COPYRIGHT` The internal copyright field.

Constructor Summary

Constructors
Constructor and Description

CatalogEntryAttachmentDeleteCmdImpl()

Constructors
Constructor and Description
`CatalogEntryAttachmentDeleteCmdImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getCatentryId()` Gets the Catalog Entry ID.
`java.lang.String`	`getPartnumber()` Gets the part number of the catalog entry.
`AccessVector`	`getResources()` Gets the access vector accessed by this command.
`void`	`performExecute()` Call the `performExecute` method from the parent to delete the attachment relation.
`protected void`	`preSetParameters()` Sets the parameters that have not been set
`void`	`reset()` Resets the variables used.
`void`	`setCatentryId(java.lang.Long anCatalogEntryId)` Sets the Catalog Entry ID.
`void`	`setPartnumber(java.lang.String astrPartnumber)` Sets the part number of the catalog entry.
`void`	`setRequestProperties(TypedProperty reqParms)` Sets the request properties.
`void`	`validateParameters()` Validates the input parameters.

Methods inherited from class com.ibm.commerce.attachment.commands.AttachmentRelationBaseDeleteCmdImpl
getAttachmentObjectTypeId, getAttachmentRelationId, getAttachmentRelationUsageId, getAttachmentTargetId, getDeleteByBusinessObject, getMemberId, getObjectId, getURL, setAttachmentObjectTypeId, setAttachmentRelationId, setAttachmentRelationUsageId, setAttachmentTargetId, setDeleteByBusinessObject, setMemberId, setObjectId, setURL

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl
checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

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.attachment.commands.AttachmentRelationBaseDeleteCmd
getAttachmentRelationId, getAttachmentRelationUsageId, getAttachmentTargetId, getDeleteByBusinessObject, getURL, setAttachmentRelationId, setAttachmentRelationUsageId, setAttachmentTargetId, setDeleteByBusinessObject, setURL

Methods inherited from interface com.ibm.commerce.command.ControllerCommand
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, 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, 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, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

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

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

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The internal copyright field.
    
    See Also:
    
    Constant Field Values
  - CLASSNAME
```
public static final java.lang.String CLASSNAME
```
    Define the CLASSNAME.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CatalogEntryAttachmentDeleteCmdImpl
```
public CatalogEntryAttachmentDeleteCmdImpl()
```
- Method Detail
  - setCatentryId
```
public void setCatentryId(java.lang.Long anCatalogEntryId)
```
    Sets the Catalog Entry ID. This also sets the object id of the attachment relationship.
    
    Specified by:
    
    setCatentryId in interface CatalogEntryAttachmentDeleteCmd
    
    Parameters:
    
    anCatalogEntryId - The Catalog Entry ID
  - setPartnumber
```
public void setPartnumber(java.lang.String astrPartnumber)
```
    Sets the part number of the catalog entry.
    
    Specified by:
    
    setPartnumber in interface CatalogEntryAttachmentDeleteCmd
    
    Parameters:
    
    astrPartnumber - The part number of the Catalog Entry
  - getCatentryId
```
public java.lang.Long getCatentryId()
```
    Gets the Catalog Entry ID.
    
    Specified by:
    
    getCatentryId in interface CatalogEntryAttachmentDeleteCmd
    
    Returns:
    
    The Catalog Entry ID
  - getPartnumber
```
public java.lang.String getPartnumber()
```
    Gets the part number of the catalog entry.
    
    Specified by:
    
    getPartnumber in interface CatalogEntryAttachmentDeleteCmd
    
    Returns:
    
    the part number of the catalog entry
  - performExecute
```
public void performExecute()
                    throws ECException
```
    Call the performExecute method from the parent to delete the attachment relation. Then, set the response properties.
    
    Specified by:
    
    performExecute in interface ECCommand
    
    Specified by:
    
    performExecute in interface com.ibm.websphere.command.TargetableCommand
    
    Overrides:
    
    performExecute in class AttachmentRelationBaseDeleteCmdImpl
    
    Throws:
    
    ECException
  - setRequestProperties
```
public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException
```
    Sets the request properties.
    
    Specified by:
    
    setRequestProperties in interface ControllerCommand
    
    Overrides:
    
    setRequestProperties in class AttachmentRelationBaseDeleteCmdImpl
    
    Parameters:
    
    reqParms - The request properties
    
    Throws:
    
    ECApplicationException
  - validateParameters
```
public void validateParameters()
                        throws ECException
```
    Validates the input parameters.
    
    Specified by:
    
    validateParameters in interface ECCommand
    
    Overrides:
    
    validateParameters in class AttachmentRelationBaseDeleteCmdImpl
    
    Throws:
    
    ECException
  - preSetParameters
```
protected void preSetParameters()
                         throws ECException
```
    Sets the parameters that have not been set
    
    Overrides:
    
    preSetParameters in class AttachmentRelationBaseDeleteCmdImpl
    
    Throws:
    
    ECException
  - reset
```
public void reset()
```
    Resets the variables used.
    
    Specified by:
    
    reset in interface com.ibm.websphere.command.Command
    
    Overrides:
    
    reset in class AttachmentRelationBaseDeleteCmdImpl
  - getResources
```
public AccessVector getResources()
                          throws ECException
```
    Gets the access vector accessed by this command. The access vector consists of a CatalogEntryAccessBean. which is the owner of the attachment relation.
    
    Specified by:
    
    getResources in interface ECCommand
    
    Overrides:
    
    getResources in class AbstractECTargetableCommand
    
    Returns:
    
    AccessVector - a vector of a CatalogEntryAccessBean.
    
    Throws:
    
    ECException

Class CatalogEntryAttachmentDeleteCmdImpl

Field Summary

Fields inherited from class com.ibm.commerce.command.ControllerCommandImpl

Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

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

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

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.attachment.commands.AttachmentRelationBaseDeleteCmdImpl

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.attachment.commands.AttachmentRelationBaseDeleteCmd

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

Constructor Detail

CatalogEntryAttachmentDeleteCmdImpl

Method Detail

setCatentryId

setPartnumber

getCatentryId

getPartnumber

performExecute

setRequestProperties

validateParameters

preSetParameters

reset

getResources