public class AttachmentDataBean
extends com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
implements com.ibm.commerce.attachment.beans.AttachmentInputDataBean, com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
AttachmentRelationAccessBean
and the command context. Information about the attachment may be obtained by the
get methods provided in this databean. AttachmentRelationAccessBean
but many of the methods from the
access beans should not be used. Only the sequence from the attachment relation is useful in this databean.
All the get and set methods extended from the access bean are deprecated. All the display information required
for the attachment are already made available by the get methods in this databean.
If specific informations are needed from the attachment tables, please refers to the corresponding access beans. For example,
the AttachmentRelationAccessBean
, AttachmentTargetAccessBean
, and
AttachmentAssetAccessBean
.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASSNAME
Define the CLASSNAME.
|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
emptyString
Constructor and Description |
---|
AttachmentDataBean(com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean abAttachmentRel,
CommandContext context)
Constructs an
AttachmentDataBean from a AttachmentRelationAccessBean . |
Modifier and Type | Method and Description |
---|---|
AttachmentAssetDataBean[] |
getAttachmentAssets()
This method gets the attachment assets for the current language.
|
java.lang.String |
getAttachmentObjectTypeId()
Deprecated.
This method should never be used.
|
java.lang.Integer |
getAttachmentObjectTypeIdInEntityType()
Deprecated.
This method should never be used.
|
java.lang.String |
getAttachmentRelationId()
Deprecated.
This method should never be used.
|
java.lang.Long |
getAttachmentRelationIdInEntityType()
Deprecated.
This method should never be used.
|
com.ibm.commerce.attachment.objects.AttachmentRelationUsageAccessBean |
getAttachmentRelationUsage()
Deprecated.
This method should never be used. Access bean should not be returned in from a databean method.
|
java.lang.String |
getAttachmentRelationUsageId()
Deprecated.
This method should never be used.
|
java.lang.Integer |
getAttachmentRelationUsageIdInEntityType()
Deprecated.
This method should never be used.
|
com.ibm.commerce.attachment.objects.AttachmentTargetAccessBean |
getAttachmentTarget()
Deprecated.
This method should never be used. Access bean should not be returned in from a databean method.
|
java.lang.String |
getAttachmentTargetId()
Deprecated.
This method should never be used.
|
java.lang.Long |
getAttachmentTargetIdInEntityType()
Deprecated.
This method should never be used.
|
CommandContext |
getCommandContext()
Gets the command context set within this bean.
|
com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean |
getDescription(java.lang.Integer anLanguageId)
Deprecated.
This method should never be used. Access bean should not be returned in from a databean method.
|
com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean |
getDescription(java.lang.Integer anLanguageId,
java.lang.Integer anStoreId)
Deprecated.
This method should never be used. Access bean should not be returned in from a databean method.
|
java.lang.Double |
getDisplaySequence()
Gets the display sequence of the attachment relation.
|
java.lang.Long |
getField1()
Gets the customizable field 1 in the attachment target.
|
java.lang.Double |
getField2()
Gets the customizable field 2 in the attachment target.
|
java.lang.String |
getField3()
Gets the customizable field 3 in the attachment target.
|
java.lang.String |
getField4()
Gets the customizable field 4 in the attachment target.
|
java.lang.String |
getFileIdentifer()
Gets the identifier of the attachment target in the attachment relation
|
java.lang.String |
getFileLongDescription()
Gets the long description of the attachment target.
|
java.lang.String |
getFileName()
Gets the file name of the attachment.
|
java.lang.String |
getFileShortDescription()
Gets the short description of the attachment target.
|
java.lang.String |
getImage1()
Gets the image 1 of the attachment asset.
|
java.lang.String |
getImage2()
Gets the image 2 of the attachment asset.
|
java.lang.Integer |
getLangaugeId()
Gets the language ID.
|
java.lang.String |
getLastUpdate()
Deprecated.
This method should never be used.
|
java.sql.Timestamp |
getLastUpdateInEntityType()
Deprecated.
This method should never be used.
|
java.lang.String |
getLongDescription()
Gets the long description of the attachment relation.
|
java.lang.String |
getMimeEncoding()
Gets the mime type encoding of the attachment asset.
|
java.lang.String |
getMimeType()
Gets the mime type of the attachment asset.
|
java.lang.String |
getName()
Gets the language dependent name of the attachment relation
|
java.lang.String |
getObjectId()
Deprecated.
This method should never be used.
|
java.lang.String |
getObjectPath()
Gets the path to attachment object based on the store ID in the attachment.
|
java.lang.Long |
getOwnerId()
Gets the member ID of the owner of the attachment target.
|
java.lang.String |
getPath()
Gets the attachment asset path.
|
TypedProperty |
getRequestProperties()
Gets the request property set within this bean.
|
java.lang.String |
getSequence()
Deprecated.
This method should never be used.
|
java.lang.Double |
getSequenceInEntityType()
Deprecated.
This method should never be used.
|
java.lang.String |
getShortDescription()
Gets the short description of the attachment relation.
|
java.lang.Integer |
getStoreId()
Gets the store ID that owns the attachment target.
|
AttachmentUsageDataBean |
getUsageDataBean()
Gets the
AttachmentUsageDataBean that is used in this attachment. |
void |
populate()
Fetches and populates information needed by the bean.
|
void |
setAttachmentObjectTypeId(java.lang.Integer newValue)
Deprecated.
This method should never be used.
|
void |
setAttachmentObjectTypeId(java.lang.String newValue)
Deprecated.
This method should never be used.
|
void |
setAttachmentRelationUsageId(java.lang.Integer newValue)
Deprecated.
This method should never be used.
|
void |
setAttachmentRelationUsageId(java.lang.String newValue)
Deprecated.
This method should never be used.
|
void |
setAttachmentTargetId(java.lang.Long newValue)
Deprecated.
This method should never be used.
|
void |
setAttachmentTargetId(java.lang.String newValue)
Deprecated.
This method should never be used.
|
void |
setCommandContext(CommandContext commandContext)
Sets the command context passed in at run time.
|
void |
setInitKey_attachmentRelationId(java.lang.Long newValue)
Deprecated.
This method should never be used.
|
void |
setLangaugeId(java.lang.Integer anLanguageId)
Sets the language ID.
|
void |
setLastUpdate(java.lang.String newValue)
Deprecated.
This method should never be used.
|
void |
setLastUpdate(java.sql.Timestamp newValue)
Deprecated.
This method should never be used.
|
void |
setObjectId(java.lang.String newValue)
Deprecated.
This method should never be used.
|
void |
setRequestProperties(TypedProperty param)
Sets the request property and populates the parameters that are needed by the bean.
|
void |
setSequence(java.lang.Double newValue)
Deprecated.
This method should never be used.
|
void |
setSequence(java.lang.String newValue)
Deprecated.
This method should never be used.
|
findByAttachmentObjectTypeId, findByAttachmentObjectTypeIdAndObjectId, findByAttachmentObjectTypeIdAndObjectIdAndRelationUsageId, findByAttachmentObjectTypeIdAndObjectIdAndTargetIdAndRelationUsageId, findByAttachmentObjectTypeIdAndRelationUsageId, findByAttachmentObjectTypeIdentifierAndObjectId, findByAttachmentObjectTypeIdentifierAndObjectIdAndRelationUsageIdentifier, findByAttachmentTargetId, findByAttachmentTargetIdAndRelationUsageId, getEntity, instantiateEntity
public static final java.lang.String COPYRIGHT
public static final java.lang.String CLASSNAME
public AttachmentDataBean(com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean abAttachmentRel, CommandContext context)
AttachmentDataBean
from a AttachmentRelationAccessBean
.abAttachmentRel
- AttachmentRelationAccessBean The AttachmentRelationAccessBean
context
- The command contextpublic CommandContext getCommandContext()
getCommandContext
in interface SmartDataBean
CommandContext
object.public java.lang.Long getField1()
getField1
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.Double getField2()
getField2
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getField3()
getField3
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getField4()
getField4
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getFileIdentifer()
getFileIdentifer
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getFileName()
getFileName
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getFileLongDescription()
getFileLongDescription
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getFileShortDescription()
getFileShortDescription
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getImage1()
getImage1
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getImage2()
getImage2
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.Integer getLangaugeId()
getLangaugeId
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getLongDescription()
getLongDescription
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getMimeType()
getMimeType
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getMimeEncoding()
getMimeEncoding
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getName()
getName
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.Long getOwnerId()
getOwnerId
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.String getPath()
getPath
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public TypedProperty getRequestProperties()
getRequestProperties
in interface InputDataBean
null
is always returned.public java.lang.Double getDisplaySequence()
public java.lang.String getShortDescription()
getShortDescription
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public java.lang.Integer getStoreId()
getStoreId
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
public AttachmentUsageDataBean getUsageDataBean()
AttachmentUsageDataBean
that is used in this attachment.getUsageDataBean
in interface com.ibm.commerce.attachment.beans.AttachmentSmartDataBean
AttachmentUsageDataBean
public java.lang.String getObjectPath() throws ECException
ECException
- An exception occurs during the execution of the method.public AttachmentAssetDataBean[] getAttachmentAssets()
AttachmentAssetDataBean
public void populate() throws java.lang.Exception
populate
in interface SmartDataBean
java.lang.Exception
- Any exception capturedpublic void setCommandContext(CommandContext commandContext)
setCommandContext
in interface SmartDataBean
commandContext
- The command context as CommandContext
object.public void setLangaugeId(java.lang.Integer anLanguageId)
setLangaugeId
in interface com.ibm.commerce.attachment.beans.AttachmentInputDataBean
anLanguageId
- The language IDpublic void setRequestProperties(TypedProperty param)
setRequestProperties
in interface InputDataBean
param
- The request property as TypedProperty
object.public java.lang.String getAttachmentTargetId()
getAttachmentTargetId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setAttachmentTargetId(java.lang.String newValue)
setAttachmentTargetId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment target IDpublic void setAttachmentTargetId(java.lang.Long newValue)
setAttachmentTargetId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment target IDpublic java.lang.String getObjectId()
getObjectId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setObjectId(java.lang.String newValue)
setObjectId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The primary key of the business object in the attachment relationpublic java.lang.String getAttachmentRelationUsageId()
getAttachmentRelationUsageId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setAttachmentRelationUsageId(java.lang.Integer newValue)
setAttachmentRelationUsageId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment relation usage IDpublic java.lang.String getAttachmentObjectTypeId()
getAttachmentObjectTypeId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setAttachmentObjectTypeId(java.lang.Integer newValue)
setAttachmentObjectTypeId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment object type ID of the business objectpublic java.lang.String getAttachmentRelationId()
getAttachmentRelationId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public java.lang.String getLastUpdate()
getLastUpdate
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setLastUpdate(java.sql.Timestamp newValue)
setLastUpdate
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The last update time of the attachment relationpublic java.lang.String getSequence()
getSequence
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setSequence(java.lang.Double newValue)
setSequence
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The sequence of the attachment relationpublic void setInitKey_attachmentRelationId(java.lang.Long newValue)
AttachmentDataBean
,
a new AttachmentDataBean
should be used instead.setInitKey_attachmentRelationId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The primary key of the attachment relationpublic java.lang.Long getAttachmentTargetIdInEntityType()
getAttachmentTargetIdInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public java.lang.Integer getAttachmentRelationUsageIdInEntityType()
getAttachmentRelationUsageIdInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setAttachmentRelationUsageId(java.lang.String newValue)
setAttachmentRelationUsageId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment relation usage IDpublic java.lang.Integer getAttachmentObjectTypeIdInEntityType()
getAttachmentObjectTypeIdInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setAttachmentObjectTypeId(java.lang.String newValue)
setAttachmentObjectTypeId
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The attachment object type ID of the business objectpublic java.lang.Long getAttachmentRelationIdInEntityType()
getAttachmentRelationIdInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public java.sql.Timestamp getLastUpdateInEntityType()
getLastUpdateInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setLastUpdate(java.lang.String newValue)
setLastUpdate
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The last update time of the attachment relationpublic java.lang.Double getSequenceInEntityType()
getSequenceInEntityType
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public void setSequence(java.lang.String newValue)
setSequence
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
newValue
- The sequence of the attachment relationpublic com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean getDescription(java.lang.Integer anLanguageId, java.lang.Integer anStoreId)
getDescription
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
anLanguageId
- The language IDanStoreId
- The store IDRemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public com.ibm.commerce.attachment.objects.AttachmentTargetAccessBean getAttachmentTarget()
getAttachmentTarget
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public com.ibm.commerce.attachment.objects.AttachmentRelationUsageAccessBean getAttachmentRelationUsage()
getAttachmentRelationUsage
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
RemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.public com.ibm.commerce.attachment.objects.AttachmentRelationDescriptionAccessBean getDescription(java.lang.Integer anLanguageId)
getDescription
in class com.ibm.commerce.attachment.objects.AttachmentRelationAccessBean
anLanguageId
- The language IDRemoteException
- EJB Remote Exception captured.CreateException
- EJB Create Exception captured.FinderException
- EJB Finder Exception captured.NamingException
- EJB Naming Exception captured.