com.ibm.commerce.attachment.commands

Interface DeleteAttachmentAssetCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand

All Known Implementing Classes:

DeleteAttachmentAssetCmdImpl

public interface DeleteAttachmentAssetCmd
extends TaskCommand

Interface for the command DeleteAttachmentAsset

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 interface com.ibm.commerce.command.CacheableECCommand

defaultCommandClassName

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getAttachmentAssetId() Gets the attachment asset ID.
java.lang.String	getAttachmentAssetPath() Gets the path for the attachment asset.
java.lang.Long	getAttachmentTargetId() Gets the attachment target ID that owns the attachment asset.
java.lang.Boolean	getDeleteByAttachmentTarget() Gets option value for deleting the attachment assets by attachment target ID.
java.lang.Integer	getStoreentId() Gets the store entity ID.
void	setAttachmentAssetId(java.lang.Long anAttachmentAssetId) Sets the attachment asset ID.
void	setAttachmentAssetPath(java.lang.String astrAttachmentAssetPath) Sets the path of the attachment asset.
void	setAttachmentTargetId(java.lang.Long anAttachmentTargetId) Sets the attachment target ID.
void	setDeleteByAttachmentTarget(java.lang.Boolean aboolDeleteByAttachmentTarget) Sets option value for deleting the attachment assets by attachment target ID.
void	setRequestProperties(TypedProperty reqParms) Sets the request properties.
void	setStoreentId(java.lang.Integer anStoreentId) Sets the store entity ID.

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

execute

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.Command

isReadyToCallExecute, reset

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

unionDependencies

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

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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

Define the CLASSNAME.

See Also:

Constant Field Values

Method Detail

getAttachmentAssetId

java.lang.Long getAttachmentAssetId()

Gets the attachment asset ID.

Returns:

The attachment asset ID

getAttachmentTargetId

java.lang.Long getAttachmentTargetId()

Gets the attachment target ID that owns the attachment asset.

Returns:

The attachment target ID

getStoreentId

java.lang.Integer getStoreentId()

Gets the store entity ID.

Returns:

The store entity ID

getAttachmentAssetPath

java.lang.String getAttachmentAssetPath()

Gets the path for the attachment asset.

Returns:

The attachment asset path

getDeleteByAttachmentTarget

java.lang.Boolean getDeleteByAttachmentTarget()

Gets option value for deleting the attachment assets by attachment target ID.

• True = delete all the attachment assets of the specified attachment target ID.
• False = delete only the specified attachment asset.

By default, this option is set to False

Returns:

The option value to delete the attachment assets by attachment target ID.

setAttachmentAssetId

void setAttachmentAssetId(java.lang.Long anAttachmentAssetId)

Sets the attachment asset ID.

Parameters:

anAttachmentAssetId - The attachment asset ID

setAttachmentTargetId

void setAttachmentTargetId(java.lang.Long anAttachmentTargetId)

Sets the attachment target ID.

Parameters:

anAttachmentTargetId - The attachment target ID

setStoreentId

void setStoreentId(java.lang.Integer anStoreentId)

Sets the store entity ID.

Parameters:

anStoreentId - The store entity ID

setAttachmentAssetPath

void setAttachmentAssetPath(java.lang.String astrAttachmentAssetPath)

Sets the path of the attachment asset.

Parameters:

astrAttachmentAssetPath - The attachment asset path

setDeleteByAttachmentTarget

void setDeleteByAttachmentTarget(java.lang.Boolean aboolDeleteByAttachmentTarget)

Sets option value for deleting the attachment assets by attachment target ID.

• True = delete all the attachment assets of the specified attachment target ID.
• False = delete only the specified attachment asset.

By default, this option is set to False

Parameters:

aboolDeleteByAttachmentTarget - The option value to delete the attachment assets by attachment target ID.

setRequestProperties

void setRequestProperties(TypedProperty reqParms)
                   throws ECApplicationException

Sets the request properties.

Parameters:

reqParms - The request properties

Throws:

ECApplicationException