com.ibm.commerce.attachment.commands

Interface DeleteAttachmentRelationCmd

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:

DeleteAttachmentRelationCmdImpl

public interface DeleteAttachmentRelationCmd
extends TaskCommand

Interface for the command DeleteAttachmentRelation

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.Integer	getAttachmentObjectTypeId() Gets the attachment object type ID of the business object that owns the attachment relation.
java.lang.Long	getAttachmentRelationId() Gets the attachment relation ID.
java.lang.Integer	getAttachmentRelationUsageId() Gets the attachment relation usage ID used in this attachment relation.
java.lang.Long	getAttachmentTargetId() Gets the attachment target ID used in this attachment relation.
java.lang.Boolean	getDeleteByBusinessObject() Gets the option to delete all the attachment relations by business object.
java.lang.String	getObjectId() Gets the primary key, in the form of a string, of the business object that owns this attachment relation.
void	setAttachmentObjectTypeId(java.lang.Integer anAttachmentObjectTypeId) Sets the attachment object type ID of the business object that owns this attachment relation.
void	setAttachmentRelationId(java.lang.Long anAttachmentRelationId) Sets the attachment relation ID.
void	setAttachmentRelationUsageId(java.lang.Integer anAttachmentRelationUsageId) Sets the attachment relation usage ID used in this attachment relation.
void	setAttachmentTargetId(java.lang.Long anAttachmentTargetId) Sets the attachment target ID used in the attachment relation.
void	setDeleteByBusinessObject(java.lang.Boolean aboolDeleteByBusinessObject) Sets the option to delete all the attachment relations by business object.
void	setObjectId(java.lang.String astrObjectId) Sets the primary key, in the form of a string, of the business object that owns this attachment relation.
void	setRequestProperties(TypedProperty reqParms) Sets the request properties.

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

getAttachmentRelationId

java.lang.Long getAttachmentRelationId()

Gets the attachment relation ID.

Returns:

The attachment relation ID

getAttachmentObjectTypeId

java.lang.Integer getAttachmentObjectTypeId()

Gets the attachment object type ID of the business object that owns the attachment relation.

Returns:

The attachment object type ID

getAttachmentRelationUsageId

java.lang.Integer getAttachmentRelationUsageId()

Gets the attachment relation usage ID used in this attachment relation.

Returns:

The attachment relation usage ID

getAttachmentTargetId

java.lang.Long getAttachmentTargetId()

Gets the attachment target ID used in this attachment relation.

Returns:

The attachment target ID

getObjectId

java.lang.String getObjectId()

Gets the primary key, in the form of a string, of the business object that owns this attachment relation.

Returns:

The primary key of the business object

getDeleteByBusinessObject

java.lang.Boolean getDeleteByBusinessObject()

Gets the option to delete all the attachment relations by business object.

• True = delete all the attachment relations by the business object specified in the parameter
• False = delete by attachment relation ID or the unique index of the attachment relation

By default, this option is set to False.

Returns:

The primary key of the business object

setAttachmentRelationId

void setAttachmentRelationId(java.lang.Long anAttachmentRelationId)

Sets the attachment relation ID.

Parameters:

anAttachmentRelationId - The attachment relation ID

setAttachmentObjectTypeId

void setAttachmentObjectTypeId(java.lang.Integer anAttachmentObjectTypeId)

Sets the attachment object type ID of the business object that owns this attachment relation.

Parameters:

anAttachmentObjectTypeId - The attachment object type ID

setAttachmentRelationUsageId

void setAttachmentRelationUsageId(java.lang.Integer anAttachmentRelationUsageId)

Sets the attachment relation usage ID used in this attachment relation.

Parameters:

anAttachmentRelationUsageId - The attachment relation usage

setAttachmentTargetId

void setAttachmentTargetId(java.lang.Long anAttachmentTargetId)

Sets the attachment target ID used in the attachment relation.

Parameters:

anAttachmentTargetId - The attachment target ID

setObjectId

void setObjectId(java.lang.String astrObjectId)

Sets the primary key, in the form of a string, of the business object that owns this attachment relation.

Parameters:

astrObjectId -

setDeleteByBusinessObject

void setDeleteByBusinessObject(java.lang.Boolean aboolDeleteByBusinessObject)

Sets the option to delete all the attachment relations by business object.

• True = delete all the attachment relations by the business object specified in the parameter
• False = delete by attachment relation ID or the unique index of the attachment relation

By default, this option is set to False.

Parameters:

aboolDeleteByBusinessObject - option to delete attachment relation by business object

setRequestProperties

void setRequestProperties(TypedProperty reqParms)
                   throws ECApplicationException

Sets the request properties.

Parameters:

reqParms - The request properties

Throws:

ECApplicationException