AttachmentTargetDescriptionDataBean

java.lang.Object
- com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
- - com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
  - - com.ibm.commerce.attachment.beans.AttachmentTargetDescriptionDataBean

All Implemented Interfaces:

java.io.Serializable
```
public class AttachmentTargetDescriptionDataBean
extends com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
```
This data bean represents a description of an attachment target. This data bean is not intended to use for display purpose. Please use the AttachmentDataBean when displaying the attachment.
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 AttachmentTargetDescriptionAccessBean. 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 :
- getAttachmentTargetDescriptionId()
- getAttachmentTargetId()
- getLanguageId()
- getName()
- getShortDescription()
- getLongDescription()
- getComandContext()
- getRequestProperties()
The following set methods are available by this databean to be used in a command:
- setAttachmentTargetDescriptionId(Long)
- setAttachmentTargetId(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
`AttachmentTargetDescriptionDataBean()` Constructs an empty `AttachmentTargetDescriptionDataBean`
`AttachmentTargetDescriptionDataBean(com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean abAttachmentTargetDescription, CommandContext context)` Constructs an `AttachmentTargetDescriptionDataBean` from a `AttachmentTargetDescriptionAccessBean`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttachmentTargetDescriptionId()` Gets the attachment target description ID.
`java.lang.String`	`getAttachmentTargetId()` Gets the attachment target 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 target.
`java.lang.String`	`getName()` Gets the language dependent name of the attachment target.
`TypedProperty`	`getRequestProperties()` Gets the request property set within this bean.
`java.lang.String`	`getShortDescription()` Gets the short description of the attachment target.
`void`	`populate()` Fetches and populates information needed by the bean.
`void`	`reset()` Resets the databean
`void`	`setAttachmentTargetDescriptionId(java.lang.Long anAttachmentTargetDescriptionId)` Sets the attachment target description ID.
`void`	`setAttachmentTargetId(java.lang.Long anAttachmentTargetId)` Sets the attachment target 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.AttachmentTargetDescriptionAccessBean
findByLanguageIdAndName, findByTargetId, findByTargetIdAndLanguageId, getAttachmentTargetDescriptionIdInEntityType, getAttachmentTargetIdInEntityType, getEntity, getLanguageIdInEntityType, instantiateEntity, setAttachmentTargetId, setInitKey_attachmentTargetDescriptionId, 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
  - AttachmentTargetDescriptionDataBean
```
public AttachmentTargetDescriptionDataBean()
```
    Constructs an empty AttachmentTargetDescriptionDataBean
  - AttachmentTargetDescriptionDataBean
```
public AttachmentTargetDescriptionDataBean(com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean abAttachmentTargetDescription,
                                           CommandContext context)
```
    Constructs an AttachmentTargetDescriptionDataBean from a AttachmentTargetDescriptionAccessBean.
    
    Parameters:
    
    abAttachmentTargetDescription - The AttachmentTargetDescriptionAccessBean
    
    context - The command context
- Method Detail
  - getAttachmentTargetDescriptionId
```
public java.lang.String getAttachmentTargetDescriptionId()
```
    Gets the attachment target description ID.
    
    Overrides:
    
    getAttachmentTargetDescriptionId in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The attachment target description ID
  - getAttachmentTargetId
```
public java.lang.String getAttachmentTargetId()
```
    Gets the attachment target ID.
    
    Overrides:
    
    getAttachmentTargetId in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The attachment target ID
  - getLanguageId
```
public java.lang.String getLanguageId()
```
    Gets the language ID.
    
    Overrides:
    
    getLanguageId in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The language ID
  - getName
```
public java.lang.String getName()
```
    Gets the language dependent name of the attachment target.
    
    Overrides:
    
    getName in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The attachment target name
  - getShortDescription
```
public java.lang.String getShortDescription()
```
    Gets the short description of the attachment target.
    
    Overrides:
    
    getShortDescription in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The short description attachment target
  - getLongDescription
```
public java.lang.String getLongDescription()
```
    Gets the long description of the attachment target.
    
    Overrides:
    
    getLongDescription in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Returns:
    
    The long description attachment target
  - 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:
    
    java.lang.Exception - Any exception captured
  - setAttachmentTargetDescriptionId
```
public void setAttachmentTargetDescriptionId(java.lang.Long anAttachmentTargetDescriptionId)
```
    Sets the attachment target description ID.
    
    Parameters:
    
    anAttachmentTargetDescriptionId - The attachment target description ID
  - setAttachmentTargetId
```
public void setAttachmentTargetId(java.lang.Long anAttachmentTargetId)
```
    Sets the attachment target ID.
    
    Overrides:
    
    setAttachmentTargetId in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    Parameters:
    
    anAttachmentTargetId - The attachment target ID
  - setLanguageId
```
public void setLanguageId(java.lang.Integer anLanguageId)
```
    Sets the language ID.
    
    Overrides:
    
    setLanguageId in class com.ibm.commerce.attachment.objects.AttachmentTargetDescriptionAccessBean
    
    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.AttachmentTargetDescriptionAccessBean
    
    Parameters:
    
    astrName - The language name.
  - 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.AttachmentTargetDescriptionAccessBean
    
    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.AttachmentTargetDescriptionAccessBean
    
    Parameters:
    
    astrLongDescription - The attachment target long description
  - setCommandContext
```
public void setCommandContext(CommandContext commandContext)
```
    Sets the command context passed in at run time.
    
    Parameters:
    
    commandContext - 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.AttachmentTargetDescriptionAccessBean

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

Methods inherited from class java.lang.Object

COPYRIGHT

CLASSNAME

AttachmentTargetDescriptionDataBean

AttachmentTargetDescriptionDataBean

getAttachmentTargetDescriptionId

getAttachmentTargetId

getLanguageId

getName

getShortDescription

getLongDescription

getCommandContext

getRequestProperties

reset

populate

setAttachmentTargetDescriptionId

setAttachmentTargetId

setLanguageId

setName

setShortDescription

setLongDescription

setCommandContext

setRequestProperties