public class CollateralDataBean extends com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean implements CollateralInputDataBean, CollateralSmartDataBean
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM copyright notice field.
|
Constructor and Description |
---|
CollateralDataBean() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
constructUrlLink(java.lang.String partialUrl)
This method updates the given partially completed URL with appropriate parameter values
and builds the full URL.
|
com.ibm.commerce.attachment.beans.AttachmentDataBean |
getAttachmentDataBean()
Gets Attachment Data Bean.
|
java.lang.Long |
getCatalogId()
Gets the ID of the catalog that the shopper is currently viewing.
|
java.lang.Integer |
getCollateralID()
Gets the ID of this collateral.
|
com.ibm.commerce.command.CommandContext |
getCommandContext()
Gets the current command context
|
java.lang.String |
getCustomerField1()
Gets the customizable field 1 of this collateral.
|
java.lang.String |
getCustomerField2()
Gets the customizable field 2 of this collateral.
|
java.lang.String |
getDescriptionCustomerField1()
Gets the customizable description field 1 of this collateral.
|
java.lang.String |
getDescriptionCustomerField2()
Gets the customizable description field 2 of this collateral.
|
java.lang.String |
getFilePath()
Gets the image or flash file path of this collateral.
|
java.lang.Integer |
getLanguageId()
Gets the ID of the current language that is in use.
|
java.lang.String |
getLocation()
Gets the image or flash file location of this collateral.
|
java.lang.String |
getMarketingText()
Gets the marketing text of this collateral.
|
java.lang.String |
getMimeType()
Gets the mime type.
|
java.lang.String |
getName()
Gets the name of this collateral.
|
java.lang.String[] |
getPromotionData()
Gets the promotion data that is associated with this ad copy.
|
com.ibm.commerce.datatype.TypedProperty |
getRequestProperties()
Gets the request properties that is currently being used.
|
java.lang.Integer |
getStoreID()
Gets the ID of the store that is currently logged on to.
|
java.lang.Object[] |
getSubstitutionValues()
Gets the Substitution Values for this Collateral.
|
java.lang.Integer |
getTypeID()
Gets the ID of the type that this collateral belongs to.
|
java.lang.String |
getTypeName()
Gets the name of the type that this collateral belongs to.
|
java.lang.String |
getUrlLink()
Gets the URL link of this collateral.
|
boolean |
isPromotionValid()
Gets the promotion validation flag that is associated with this ad copy.
|
void |
populate()
Populates this data bean that represents a single collateral in the database.
|
void |
setAttachmentDataBean(com.ibm.commerce.attachment.beans.AttachmentDataBean bean)
Sets Attachment data bean
|
void |
setCatalogId(java.lang.Long newCatalogId)
Sets the ID of the catalog that the shopper is currently viewing.
|
void |
setCollateralID(java.lang.Integer newCollateralID)
Sets the ID of this collateral.
|
void |
setCommandContext(com.ibm.commerce.command.CommandContext context)
Sets the current command context.
|
void |
setCustomerField1(java.lang.String newCustomerField1)
Sets the customizable field 1 of this collateral.
|
void |
setCustomerField2(java.lang.String newCustomerField2)
Sets the customizable field 2 of this collateral.
|
void |
setDescriptionCustomerField1(java.lang.String newDescriptionCustomerField1)
Sets the customizable description field 1 of this collateral.
|
void |
setDescriptionCustomerField2(java.lang.String newDescriptionCustomerField2)
Sets the customizable description field 2 of this collateral.
|
void |
setFilePath(java.lang.String newFilePath)
Sets the image or flash file path of this collateral.
|
void |
setLanguageId(java.lang.Integer newLanguageId)
Sets the ID of the current language that is in use.
|
void |
setLocation(java.lang.String newLocation)
Sets the image or flash file location of this collateral.
|
void |
setMarketingText(java.lang.String newMarketingText)
Sets the marketing text of this collateral.
|
void |
setMimeType(java.lang.String string)
Sets mime type.
|
void |
setName(java.lang.String newName)
Sets the name of this collateral.
|
void |
setPromotionData(java.lang.String[] newPromotionData)
Sets the promotion data that is associated with this ad copy.
|
void |
setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperties)
Sets the request properties that is currently being used.
|
void |
setStoreID(java.lang.Integer newStoreID)
Sets the ID of the store that is currently logged on to.
|
void |
setSubstitutionValues(java.lang.Object[] _substitutionValues)
Set the Substitution Values for this Collateral.
|
void |
setType(java.lang.Integer newTypeID)
Sets the ID of the type that this collateral belongs to.
|
void |
setTypeName(java.lang.String newTypeName)
Sets the name of the type that this collateral belongs to.
|
void |
setUrlLink(java.lang.String newUrlLink)
Sets the URL link of this collateral.
|
findByStore, findByStoreAndName, findByStoreAndType, findByStoreAndTypeWithOrder, findByStoreSortedByName, findByStoreSortedByType, findByStoreWithOrder, fulfills, getCollateralId, getCollateralIdInEntityType, getEntity, getOwner, getStoreId, getStoreIdInEntityType, getType, getTypeInEntityType, instantiateEntity, setCollateralId, setCollateralId, setInitKey_collateralId, setInitKey_collateralId, setStoreId, setStoreId, setType
public static final java.lang.String COPYRIGHT
public java.lang.String constructUrlLink(java.lang.String partialUrl)
partialUrl
- The incomplete URL that needs to be updated.public com.ibm.commerce.attachment.beans.AttachmentDataBean getAttachmentDataBean()
public java.lang.Long getCatalogId()
public java.lang.Integer getCollateralID()
public com.ibm.commerce.command.CommandContext getCommandContext()
getCommandContext
in interface com.ibm.commerce.beans.SmartDataBean
com.ibm.commerce.command.CommandContext
public java.lang.String getCustomerField1()
getCustomerField1
in interface CollateralSmartDataBean
getCustomerField1
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
public java.lang.String getCustomerField2()
getCustomerField2
in interface CollateralSmartDataBean
getCustomerField2
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
public java.lang.String getDescriptionCustomerField1()
getDescriptionCustomerField1
in interface CollateralSmartDataBean
public java.lang.String getDescriptionCustomerField2()
getDescriptionCustomerField2
in interface CollateralSmartDataBean
public java.lang.String getFilePath()
public java.lang.Integer getLanguageId()
public java.lang.String getLocation()
getLocation
in interface CollateralSmartDataBean
public java.lang.String getMarketingText()
getMarketingText
in interface CollateralSmartDataBean
public java.lang.String getMimeType()
public java.lang.String getName()
getName
in interface CollateralSmartDataBean
getName
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
public java.lang.String[] getPromotionData()
public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
getRequestProperties
in interface com.ibm.commerce.beans.InputDataBean
com.ibm.commerce.datatype.TypedProperty
public java.lang.Integer getStoreID()
public java.lang.Object[] getSubstitutionValues()
public java.lang.Integer getTypeID()
getTypeID
in interface CollateralSmartDataBean
public java.lang.String getTypeName()
getTypeName
in interface CollateralSmartDataBean
public java.lang.String getUrlLink()
getUrlLink
in interface CollateralSmartDataBean
getUrlLink
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
public boolean isPromotionValid()
public void populate()
populate
in interface com.ibm.commerce.beans.SmartDataBean
java.lang.Exception
- Thrown when an error occurs during the population of this data bean.public void setAttachmentDataBean(com.ibm.commerce.attachment.beans.AttachmentDataBean bean)
bean
- Attachment data beanpublic void setCatalogId(java.lang.Long newCatalogId)
newCatalogId
- ID of the catalog that the shopper is currently viewing.public void setCollateralID(java.lang.Integer newCollateralID)
newCollateralID
- the collateral IDpublic void setCommandContext(com.ibm.commerce.command.CommandContext context)
setCommandContext
in interface com.ibm.commerce.beans.SmartDataBean
context
- com.ibm.commerce.command.CommandContext
public void setCustomerField1(java.lang.String newCustomerField1)
setCustomerField1
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
newCustomerField1
- the customizable field 1public void setCustomerField2(java.lang.String newCustomerField2)
setCustomerField2
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
newCustomerField2
- the customizable field 2public void setDescriptionCustomerField1(java.lang.String newDescriptionCustomerField1)
newDescriptionCustomerField1
- the customizable description field 1public void setDescriptionCustomerField2(java.lang.String newDescriptionCustomerField2)
newDescriptionCustomerField2
- the customizable description field 2public void setFilePath(java.lang.String newFilePath)
newLocation
- the collateral image or flash file pathpublic void setLanguageId(java.lang.Integer newLanguageId)
newLanguageId
- the language IDpublic void setLocation(java.lang.String newLocation)
newLocation
- the collateral image or flash file locationpublic void setMarketingText(java.lang.String newMarketingText)
newMarketingText
- the collateral marketing textpublic void setMimeType(java.lang.String string)
string
- Collateral mime typepublic void setName(java.lang.String newName)
setName
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
newName
- the collateral namepublic void setPromotionData(java.lang.String[] newPromotionData)
newPromotionData
- The promotion data that is associated with this ad copypublic void setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperties)
setRequestProperties
in interface com.ibm.commerce.beans.InputDataBean
requestProperties
- com.ibm.commerce.datatype.TypedProperty
public void setStoreID(java.lang.Integer newStoreID)
newStoreID
- the current store IDpublic void setSubstitutionValues(java.lang.Object[] _substitutionValues)
substitutionValues
- The substitutionValues to set.public void setType(java.lang.Integer newTypeID)
setType
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
newTypeID
- the collateral type IDpublic void setTypeName(java.lang.String newTypeName)
newTypeName
- the collateral type namepublic void setUrlLink(java.lang.String newUrlLink)
setUrlLink
in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
newUrlLink
- the collateral URL link