AttachmentRelationBaseUpdateCmd

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 Subinterfaces:

CatalogAttachmentUpdateCmd, CatalogEntryAttachmentUpdateCmd, CatalogGroupAttachmentUpdateCmd

All Known Implementing Classes:

AttachmentRelationBaseUpdateCmdImpl, CatalogAttachmentUpdateCmdImpl, CatalogEntryAttachmentUpdateCmdImpl, CatalogGroupAttachmentUpdateCmdImpl
```
public interface AttachmentRelationBaseUpdateCmd
extends ControllerCommand
```
Interface for AttachmentRelationBaseUpdate command. The AttachmentRelationBaseUpdate updates an attachment relationship between and attachment target and a Commerce business object; together with its attachment relation descriptions. This command must be extended from a controller command from the Commerce business object, for example, the CatalogEntryAttachmentUpdate command. The create missing option is used to determine if an attachment relation description being updated does not exists, should it be created or not. By default, it is set to true to create missing descriptions. Setting the attachment relation description requires setting a vector of AttachmentRelationDescriptionDataBeans.

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

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.lang.Long`	`getAttachmentObjectId()` Gets the ID of the business object for which this relationship is defined.
`java.util.Vector`	`getAttachmentRelationDescriptions()` Gets the vector of `AttachmentRelationDescriptionDataBean`
`java.lang.Long`	`getAttachmentRelationId()` Gets the attachment relation ID for the business object.
`java.lang.Integer`	`getAttachmentRelationUsageId()` Gets the attachment relation usage ID in the attachment relation.
`java.lang.Long`	`getAttachmentTargetId()` Gets the attachment target ID in the attachment relation.
`java.lang.Double`	`getSequence()` Gets the sequence used in the attachment relation.
`java.lang.String`	`getURL()` Gets the redirect URL.
`void`	`setAttachmentObjectId(java.lang.Long anObjectId)` Sets the ID of the business object for which this relation is defined.
`void`	`setAttachmentRelationDescriptions(java.util.Vector avAttachmentRelationDescriptionDataBeans)` Sets the vector of `AttachmentRelationDescriptionDataBean` to be created as the description for the 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.
`void`	`setAttachmentTargetId(java.lang.Long anAttachmentTargetId)` Sets the attachment target ID.
`void`	`setCreateMissing(java.lang.Boolean aboolCreateMissing)` Sets the option the create missing attachment relation and attachment relation descriptions.
`void`	`setSequence(java.lang.Double adSequence)` Sets the sequence in the attachment relation.
`void`	`setURL(java.lang.String astrURL)` Sets the redirect URL.

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
```
    Define the CLASSNAME.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getAttachmentObjectId
```
java.lang.Long getAttachmentObjectId()
```
    Gets the ID of the business object for which this relationship is defined.
    
    Returns:
    
    The Object ID
  - getAttachmentRelationId
```
java.lang.Long getAttachmentRelationId()
```
    Gets the attachment relation ID for the business object.
    
    Returns:
    
    The attachment relation ID
  - getAttachmentTargetId
```
java.lang.Long getAttachmentTargetId()
```
    Gets the attachment target ID in the attachment relation.
    
    Returns:
    
    The attachment target ID
  - getAttachmentRelationUsageId
```
java.lang.Integer getAttachmentRelationUsageId()
```
    Gets the attachment relation usage ID in the attachment relation.
    
    Returns:
    
    The attachment relation usage ID
  - getSequence
```
java.lang.Double getSequence()
```
    Gets the sequence used in the attachment relation.
    
    Returns:
    
    The sequence
  - getAttachmentRelationDescriptions
```
java.util.Vector getAttachmentRelationDescriptions()
```
    Gets the vector of AttachmentRelationDescriptionDataBean
    
    Returns:
    
    The vector of AttachmentRelationDescriptionDataBean
  - getURL
```
java.lang.String getURL()
```
    Gets the redirect URL.
    
    Returns:
    
    String The redirect URL
  - setCreateMissing
```
void setCreateMissing(java.lang.Boolean aboolCreateMissing)
```
    Sets the option the create missing attachment relation and attachment relation descriptions.
    - True - create the missing attachment relation and descriptions.
    - False - throw exception if the attachment relation or descriptions do not exists
    By default, the option is set to True.
    Parameters:
    
    aboolCreateMissing - The create missing flag
  - setAttachmentObjectId
```
void setAttachmentObjectId(java.lang.Long anObjectId)
```
    Sets the ID of the business object for which this relation is defined.
    
    Parameters:
    
    anObjectId - The Object ID
  - setAttachmentRelationId
```
void setAttachmentRelationId(java.lang.Long anAttachmentRelationId)
```
    Sets the attachment relation ID.
    
    Parameters:
    
    anAttachmentRelationId - The attachment relation ID
  - setAttachmentTargetId
```
void setAttachmentTargetId(java.lang.Long anAttachmentTargetId)
```
    Sets the attachment target ID.
    
    Parameters:
    
    anAttachmentTargetId - The attachment target ID
  - setAttachmentRelationUsageId
```
void setAttachmentRelationUsageId(java.lang.Integer anAttachmentRelationUsageId)
```
    Sets the attachment relation usage ID.
    
    Parameters:
    
    anAttachmentRelationUsageId - The attachment relation usage ID
  - setSequence
```
void setSequence(java.lang.Double adSequence)
```
    Sets the sequence in the attachment relation.
    
    Parameters:
    
    adSequence - The sequence number
  - setAttachmentRelationDescriptions
```
void setAttachmentRelationDescriptions(java.util.Vector avAttachmentRelationDescriptionDataBeans)
```
    Sets the vector of AttachmentRelationDescriptionDataBean to be created as the description for the attachment relation.
    
    Parameters:
    
    avAttachmentRelationDescriptionDataBeans - The list of AttachmentRelationDescriptionDataBean
  - setURL
```
void setURL(java.lang.String astrURL)
```
    Sets the redirect URL.
    
    Parameters:
    
    astrURL - The redirect URL

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

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

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

COPYRIGHT

CLASSNAME

getAttachmentObjectId

getAttachmentRelationId

getAttachmentTargetId

getAttachmentRelationUsageId

getSequence

getAttachmentRelationDescriptions

getURL

setCreateMissing

setAttachmentObjectId

setAttachmentRelationId

setAttachmentTargetId

setAttachmentRelationUsageId

setSequence

setAttachmentRelationDescriptions

setURL