CollateralDataBean

java.lang.Object
- com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
- - com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
  - - com.ibm.commerce.marketing.beans.CollateralDataBean

All Implemented Interfaces:

com.ibm.commerce.beans.DataBean, com.ibm.commerce.beans.InputDataBean, com.ibm.commerce.beans.SmartDataBean, CollateralInputDataBean, CollateralSmartDataBean, java.io.Serializable

Direct Known Subclasses:

EMarketingSpot.Collateral
```
public class CollateralDataBean
extends com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
implements CollateralInputDataBean, CollateralSmartDataBean
```
This data bean represents an Ad copy. It encapsulates the data from the COLLATERAL, COLLDESC, and COLLTYPE tables.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

CollateralDataBean()

Constructors
Constructor and Description
`CollateralDataBean()`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
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

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
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - CollateralDataBean
```
public CollateralDataBean()
```
- Method Detail
  - constructUrlLink
```
public 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.
    
    Parameters:
    
    partialUrl - The incomplete URL that needs to be updated.
    
    Returns:
    
    Updated URL
  - getAttachmentDataBean
```
public com.ibm.commerce.attachment.beans.AttachmentDataBean getAttachmentDataBean()
```
    Gets Attachment Data Bean.
    
    Returns:
    
    Attachment data bean
  - getCatalogId
```
public java.lang.Long getCatalogId()
```
    Gets the ID of the catalog that the shopper is currently viewing.
    
    Returns:
    
    ID of the catalog that the shopper is currently viewing.
  - getCollateralID
```
public java.lang.Integer getCollateralID()
```
    Gets the ID of this collateral.
    
    Returns:
    
    the collateral ID
  - getCommandContext
```
public com.ibm.commerce.command.CommandContext getCommandContext()
```
    Gets the current command context
    
    Specified by:
    
    getCommandContext in interface com.ibm.commerce.beans.SmartDataBean
    
    Returns:
    
    com.ibm.commerce.command.CommandContext
  - getCustomerField1
```
public java.lang.String getCustomerField1()
```
    Gets the customizable field 1 of this collateral.
    
    Specified by:
    
    getCustomerField1 in interface CollateralSmartDataBean
    
    Overrides:
    
    getCustomerField1 in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Returns:
    
    the customizable field 1
  - getCustomerField2
```
public java.lang.String getCustomerField2()
```
    Gets the customizable field 2 of this collateral.
    
    Specified by:
    
    getCustomerField2 in interface CollateralSmartDataBean
    
    Overrides:
    
    getCustomerField2 in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Returns:
    
    the customizable field 2
  - getDescriptionCustomerField1
```
public java.lang.String getDescriptionCustomerField1()
```
    Gets the customizable description field 1 of this collateral.
    
    Specified by:
    
    getDescriptionCustomerField1 in interface CollateralSmartDataBean
    
    Returns:
    
    the customizable description field 1
  - getDescriptionCustomerField2
```
public java.lang.String getDescriptionCustomerField2()
```
    Gets the customizable description field 2 of this collateral.
    
    Specified by:
    
    getDescriptionCustomerField2 in interface CollateralSmartDataBean
    
    Returns:
    
    the customizable description field 2
  - getFilePath
```
public java.lang.String getFilePath()
```
    Gets the image or flash file path of this collateral.
    
    Returns:
    
    the collateral image or flash file path
  - getLanguageId
```
public java.lang.Integer getLanguageId()
```
    Gets the ID of the current language that is in use.
    
    Returns:
    
    the language ID
  - getLocation
```
public java.lang.String getLocation()
```
    Gets the image or flash file location of this collateral.
    
    Specified by:
    
    getLocation in interface CollateralSmartDataBean
    
    Returns:
    
    the collateral image or flash file location
  - getMarketingText
```
public java.lang.String getMarketingText()
```
    Gets the marketing text of this collateral.
    
    Specified by:
    
    getMarketingText in interface CollateralSmartDataBean
    
    Returns:
    
    the collateral marketing text
  - getMimeType
```
public java.lang.String getMimeType()
```
    Gets the mime type.
    
    Returns:
    
    Collateral mime type
  - getName
```
public java.lang.String getName()
```
    Gets the name of this collateral.
    
    Specified by:
    
    getName in interface CollateralSmartDataBean
    
    Overrides:
    
    getName in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Returns:
    
    the collateral name
  - getPromotionData
```
public java.lang.String[] getPromotionData()
```
    Gets the promotion data that is associated with this ad copy.
    
    Returns:
    
    The promotion data that is associated with this ad copy
  - getRequestProperties
```
public com.ibm.commerce.datatype.TypedProperty getRequestProperties()
```
    Gets the request properties that is currently being used.
    
    Specified by:
    
    getRequestProperties in interface com.ibm.commerce.beans.InputDataBean
    
    Returns:
    
    com.ibm.commerce.datatype.TypedProperty
  - getStoreID
```
public java.lang.Integer getStoreID()
```
    Gets the ID of the store that is currently logged on to.
    
    Returns:
    
    the current store ID
  - getSubstitutionValues
```
public java.lang.Object[] getSubstitutionValues()
```
    Gets the Substitution Values for this Collateral.
    
    Returns:
    
    Returns the substitutionValues.
  - getTypeID
```
public java.lang.Integer getTypeID()
```
    Gets the ID of the type that this collateral belongs to.
    
    Specified by:
    
    getTypeID in interface CollateralSmartDataBean
    
    Returns:
    
    the collateral type ID
  - getTypeName
```
public java.lang.String getTypeName()
```
    Gets the name of the type that this collateral belongs to.
    
    Specified by:
    
    getTypeName in interface CollateralSmartDataBean
    
    Returns:
    
    the collateral type name
  - getUrlLink
```
public java.lang.String getUrlLink()
```
    Gets the URL link of this collateral.
    
    Specified by:
    
    getUrlLink in interface CollateralSmartDataBean
    
    Overrides:
    
    getUrlLink in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Returns:
    
    the collateral URL link
  - isPromotionValid
```
public boolean isPromotionValid()
```
    Gets the promotion validation flag that is associated with this ad copy.
    
    Returns:
    
    True if the promotion that is associated with this ad copy is valid; false otherwise.
  - populate
```
public void populate()
```
    Populates this data bean that represents a single collateral in the database.
    
    Specified by:
    
    populate in interface com.ibm.commerce.beans.SmartDataBean
    
    Throws:
    
    java.lang.Exception - Thrown when an error occurs during the population of this data bean.
  - setAttachmentDataBean
```
public void setAttachmentDataBean(com.ibm.commerce.attachment.beans.AttachmentDataBean bean)
```
    Sets Attachment data bean
    
    Parameters:
    
    bean - Attachment data bean
  - setCatalogId
```
public void setCatalogId(java.lang.Long newCatalogId)
```
    Sets the ID of the catalog that the shopper is currently viewing. If this is not set, then the system will assume that the master catalog of the current store is in use.
    
    Parameters:
    
    newCatalogId - ID of the catalog that the shopper is currently viewing.
  - setCollateralID
```
public void setCollateralID(java.lang.Integer newCollateralID)
```
    Sets the ID of this collateral.
    
    Parameters:
    
    newCollateralID - the collateral ID
  - setCommandContext
```
public void setCommandContext(com.ibm.commerce.command.CommandContext context)
```
    Sets the current command context.
    
    Specified by:
    
    setCommandContext in interface com.ibm.commerce.beans.SmartDataBean
    
    Parameters:
    
    context - com.ibm.commerce.command.CommandContext
  - setCustomerField1
```
public void setCustomerField1(java.lang.String newCustomerField1)
```
    Sets the customizable field 1 of this collateral.
    
    Overrides:
    
    setCustomerField1 in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Parameters:
    
    newCustomerField1 - the customizable field 1
  - setCustomerField2
```
public void setCustomerField2(java.lang.String newCustomerField2)
```
    Sets the customizable field 2 of this collateral.
    
    Overrides:
    
    setCustomerField2 in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Parameters:
    
    newCustomerField2 - the customizable field 2
  - setDescriptionCustomerField1
```
public void setDescriptionCustomerField1(java.lang.String newDescriptionCustomerField1)
```
    Sets the customizable description field 1 of this collateral.
    
    Parameters:
    
    newDescriptionCustomerField1 - the customizable description field 1
  - setDescriptionCustomerField2
```
public void setDescriptionCustomerField2(java.lang.String newDescriptionCustomerField2)
```
    Sets the customizable description field 2 of this collateral.
    
    Parameters:
    
    newDescriptionCustomerField2 - the customizable description field 2
  - setFilePath
```
public void setFilePath(java.lang.String newFilePath)
```
    Sets the image or flash file path of this collateral.
    
    Parameters:
    
    newLocation - the collateral image or flash file path
  - setLanguageId
```
public void setLanguageId(java.lang.Integer newLanguageId)
```
    Sets the ID of the current language that is in use.
    
    Parameters:
    
    newLanguageId - the language ID
  - setLocation
```
public void setLocation(java.lang.String newLocation)
```
    Sets the image or flash file location of this collateral.
    
    Parameters:
    
    newLocation - the collateral image or flash file location
  - setMarketingText
```
public void setMarketingText(java.lang.String newMarketingText)
```
    Sets the marketing text of this collateral.
    
    Parameters:
    
    newMarketingText - the collateral marketing text
  - setMimeType
```
public void setMimeType(java.lang.String string)
```
    Sets mime type.
    
    Parameters:
    
    string - Collateral mime type
  - setName
```
public void setName(java.lang.String newName)
```
    Sets the name of this collateral.
    
    Overrides:
    
    setName in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Parameters:
    
    newName - the collateral name
  - setPromotionData
```
public void setPromotionData(java.lang.String[] newPromotionData)
```
    Sets the promotion data that is associated with this ad copy.
    
    Parameters:
    
    newPromotionData - The promotion data that is associated with this ad copy
  - setRequestProperties
```
public void setRequestProperties(com.ibm.commerce.datatype.TypedProperty requestProperties)
```
    Sets the request properties that is currently being used.
    
    Specified by:
    
    setRequestProperties in interface com.ibm.commerce.beans.InputDataBean
    
    Parameters:
    
    requestProperties - com.ibm.commerce.datatype.TypedProperty
  - setStoreID
```
public void setStoreID(java.lang.Integer newStoreID)
```
    Sets the ID of the store that is currently logged on to.
    
    Parameters:
    
    newStoreID - the current store ID
  - setSubstitutionValues
```
public void setSubstitutionValues(java.lang.Object[] _substitutionValues)
```
    Set the Substitution Values for this Collateral.
    
    Parameters:
    
    substitutionValues - The substitutionValues to set.
  - setType
```
public void setType(java.lang.Integer newTypeID)
```
    Sets the ID of the type that this collateral belongs to.
    
    Overrides:
    
    setType in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Parameters:
    
    newTypeID - the collateral type ID
  - setTypeName
```
public void setTypeName(java.lang.String newTypeName)
```
    Sets the name of the type that this collateral belongs to.
    
    Parameters:
    
    newTypeName - the collateral type name
  - setUrlLink
```
public void setUrlLink(java.lang.String newUrlLink)
```
    Sets the URL link of this collateral.
    
    Overrides:
    
    setUrlLink in class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
    
    Parameters:
    
    newUrlLink - the collateral URL link

Fields inherited from interface com.ibm.commerce.beans.DataBean

Methods inherited from class com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean

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

Methods inherited from class java.lang.Object

COPYRIGHT

CollateralDataBean

constructUrlLink

getAttachmentDataBean

getCatalogId

getCollateralID

getCommandContext

getCustomerField1

getCustomerField2

getDescriptionCustomerField1

getDescriptionCustomerField2

getFilePath

getLanguageId

getLocation

getMarketingText

getMimeType

getName

getPromotionData

getRequestProperties

getStoreID

getSubstitutionValues

getTypeID

getTypeName

getUrlLink

isPromotionValid

populate

setAttachmentDataBean

setCatalogId

setCollateralID

setCommandContext

setCustomerField1

setCustomerField2

setDescriptionCustomerField1

setDescriptionCustomerField2

setFilePath

setLanguageId

setLocation

setMarketingText

setMimeType

setName

setPromotionData

setRequestProperties

setStoreID

setSubstitutionValues

setType

setTypeName

setUrlLink