AttachmentRelationDescriptionDataBean

java.lang.Object
- com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
- - com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
  - - com.ibm.commerce.attachment.beans.AttachmentRelationDescriptionDataBean

All Implemented Interfaces:

java.io.Serializable
```
public class AttachmentRelationDescriptionDataBean
extends com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
```
This data bean represents a description of an attachment relation. This data bean is not intended to use for display purpose. Please use the AttachmentDataBean when displaying the attachment. The databean is used in the commands that create or update attachment relation together with its descriptions.
Use only the get methods that returns String type in this databean when being called in the command. This is because the other get methods are extended from the AttachmentRelationDescriptionAccessBean. And if a new description is being created in a command, no such data exists yet and an exception will be thrown. The following get methods are available by this databean to be used in a command :
- getAttachmentRelationDescriptionId()
- getAttachmentRelationId()
- getLanguageId()
- getName()
- getShortDescription()
- getLongDescription()
- getComandContext()
- getRequestProperties()
The following set methods are available by this databean to be used in a command:
- setAttachmentRelationDescriptionId(Long)
- setAttachmentRelationId(Long)
- setLanguageId(Integer)
- setName(String)
- setShortDescription(String)
- setLongDescription(String)
- setCommandContext(CommandContext)
- setRequestProperties(TypeProperties)
See Also:

Serialized Form

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
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
`AttachmentRelationDescriptionDataBean()` Constructs an empty `AttachmentRelationDescriptionDataBean`
`AttachmentRelationDescriptionDataBean(com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean abAttachmentRelationDescription, CommandContext context)` Constructs an `AttachmentRelationDescriptionDataBean` from a `AttachmentRelationDescriptionAccessBean`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttachmentRelationDescriptionId()` Gets the attachment relation description ID.
`java.lang.String`	`getAttachmentRelationId()` Gets the attachment relation ID.
`CommandContext`	`getCommandContext()` Gets the command context set within this bean.
`java.lang.String`	`getLanguageId()` Gets the language ID.
`java.lang.String`	`getLongDescription()` Gets the long description of the attachment relation.
`java.lang.String`	`getName()` Gets the language dependent name of the attachment relation.
`TypedProperty`	`getRequestProperties()` Gets the request property set within this bean.
`java.lang.String`	`getShortDescription()` Gets the short description of the attachment relation.
`void`	`populate()` Fetches and populates information needed by the bean.
`void`	`reset()` Resets the databean
`void`	`setAttachmentRelationDescriptionId(java.lang.Long anAttachmentRelationDescriptionId)` Sets the attachment relation description ID.
`void`	`setAttachmentRelationId(java.lang.Long anAttachmentRelationId)` Sets the attachment relation ID.
`void`	`setCommandContext(CommandContext commandContext)` Sets the command context passed in at run time.
`void`	`setLanguageId(java.lang.Integer anLanguageId)` Sets the language ID.
`void`	`setLongDescription(java.lang.String astrLongDescription)` Sets the long description of the attachment target.
`void`	`setName(java.lang.String astrName)` Sets the language dependent name of the attachment target.
`void`	`setRequestProperties(TypedProperty param)` Sets the request property and populates the parameters that are needed by the bean.
`void`	`setShortDescription(java.lang.String astrShortDescription)` Sets the short description of the attachment target.

Methods inherited from class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
findByAttachmentRelationId, findByAttachmentRelationIdAndLanguageId, findByLanguageIdAndName, getAttachmentRelationDescriptionIdInEntityType, getAttachmentRelationIdInEntityType, getEntity, getLanguageIdInEntityType, instantiateEntity, setAttachmentRelationId, setInitKey_attachmentRelationDescriptionId, setLanguageId

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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
  - AttachmentRelationDescriptionDataBean
```
public AttachmentRelationDescriptionDataBean()
```
    Constructs an empty AttachmentRelationDescriptionDataBean
  - AttachmentRelationDescriptionDataBean
```
public AttachmentRelationDescriptionDataBean(com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean abAttachmentRelationDescription,
                                             CommandContext context)
```
    Constructs an AttachmentRelationDescriptionDataBean from a AttachmentRelationDescriptionAccessBean.
    
    Parameters:
    
    abAttachmentRelationDescription - The AttachmentRelationDescriptionAccessBean
    
    context - The command context
- Method Detail
  - getAttachmentRelationDescriptionId
```
public java.lang.String getAttachmentRelationDescriptionId()
```
    Gets the attachment relation description ID.
    
    Overrides:
    
    getAttachmentRelationDescriptionId in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The attachment relation description ID
  - getAttachmentRelationId
```
public java.lang.String getAttachmentRelationId()
```
    Gets the attachment relation ID.
    
    Overrides:
    
    getAttachmentRelationId in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The attachment relation ID
  - getLanguageId
```
public java.lang.String getLanguageId()
```
    Gets the language ID.
    
    Overrides:
    
    getLanguageId in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The language ID
  - getName
```
public java.lang.String getName()
```
    Gets the language dependent name of the attachment relation.
    
    Overrides:
    
    getName in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The attachment relation name
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Gets the short description of the attachment relation.
    
    Overrides:
    
    getShortDescription in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The short description attachment relation
  - getLongDescription
```
public java.lang.String getLongDescription()
```
    Gets the long description of the attachment relation.
    
    Overrides:
    
    getLongDescription in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Returns:
    
    The long description attachment relation
  - getCommandContext
```
public CommandContext getCommandContext()
```
    Gets the command context set within this bean.
    
    Returns:
    
    The command context as CommandContext object.
  - getRequestProperties
```
public TypedProperty getRequestProperties()
```
    Gets the request property set within this bean. This databean does not set anything in the request properties.
    
    Returns:
    
    an empty request properties is always returned.
  - reset
```
public void reset()
```
    Resets the databean
  - populate
```
public void populate()
```
    Fetches and populates information needed by the bean.
    
    Throws:
    
    Any - exception captured
  - setAttachmentRelationDescriptionId
```
public void setAttachmentRelationDescriptionId(java.lang.Long anAttachmentRelationDescriptionId)
```
    Sets the attachment relation description ID.
    
    Parameters:
    
    anAttachmentRelationDescriptionId - The attachment relation description ID
  - setAttachmentRelationId
```
public void setAttachmentRelationId(java.lang.Long anAttachmentRelationId)
```
    Sets the attachment relation ID.
    
    Overrides:
    
    setAttachmentRelationId in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Parameters:
    
    anAttachmentRelationId - The attachment relation ID
  - setLanguageId
```
public void setLanguageId(java.lang.Integer anLanguageId)
```
    Sets the language ID.
    
    Overrides:
    
    setLanguageId in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Parameters:
    
    anLanguageId - The language ID
  - setName
```
public void setName(java.lang.String astrName)
```
    Sets the language dependent name of the attachment target.
    
    Overrides:
    
    setName in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Parameters:
    
    anLanguageId - The language ID
  - setShortDescription
```
public void setShortDescription(java.lang.String astrShortDescription)
```
    Sets the short description of the attachment target.
    
    Overrides:
    
    setShortDescription in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Parameters:
    
    astrShortDescription - The short description of the attachment target.
  - setLongDescription
```
public void setLongDescription(java.lang.String astrLongDescription)
```
    Sets the long description of the attachment target.
    
    Overrides:
    
    setLongDescription in class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean
    
    Parameters:
    
    astrLongDescription - The attachment target long description
  - setCommandContext
```
public void setCommandContext(CommandContext commandContext)
```
    Sets the command context passed in at run time.
    
    Parameters:
    
    aCommandContext - The command context as CommandContext object.
  - setRequestProperties
```
public void setRequestProperties(TypedProperty param)
```
    Sets the request property and populates the parameters that are needed by the bean.
    
    Parameters:
    
    param - The request property as TypedProperty object.

Methods inherited from class com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

Methods inherited from class java.lang.Object

COPYRIGHT

CLASSNAME

AttachmentRelationDescriptionDataBean

AttachmentRelationDescriptionDataBean

getAttachmentRelationDescriptionId

getAttachmentRelationId

getLanguageId

getName

getShortDescription

getLongDescription

getCommandContext

getRequestProperties

reset

populate

setAttachmentRelationDescriptionId

setAttachmentRelationId

setLanguageId

setName

setShortDescription

setLongDescription

setCommandContext

setRequestProperties