com.ibm.commerce.marketing.beans
Class CollateralDataBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
        |
        +--com.ibm.commerce.marketingcenter.campaign.objects.CollateralAccessBean
              |
              +--com.ibm.commerce.marketing.beans.CollateralDataBean
All Implemented Interfaces:
CollateralInputDataBean, CollateralSmartDataBean, DataBean, InputDataBean, java.io.Serializable, SmartDataBean
Direct Known Subclasses:
EMarketingSpot.Collateral

public class CollateralDataBean
extends 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
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
CollateralDataBean()
           
 
Method Summary
 java.lang.Integer getCollateralID()
          Gets the ID of this collateral.
  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.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 getName()
          Gets the name of this collateral.
  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.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.
 void populate()
          Populates this data bean that represents a single collateral in the database.
 void setCollateralID(java.lang.Integer newCollateralID)
          Sets the ID of this collateral.
 void setCommandContext( 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 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 setName(java.lang.String newName)
          Sets the name of this collateral.
 void setRequestProperties( 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 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
commitCopyHelper, defaultJNDIName, findByStore, findByStoreAndName, findByStoreAndType, findByStoreAndTypeWithOrder, findByStoreSortedByName, findByStoreSortedByType, findByStoreWithOrder, fulfills, getCollateralId, getCollateralIdInEJBType, getOwner, getStoreId, getStoreIdInEJBType, getType, getTypeInEJBType, instantiateEJB, instantiateEJBByPrimaryKey, refreshCopyHelper, setCollateralId, setCollateralId, setInitKey_collateralId, setStoreId, setStoreId, setType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
IBM copyright notice field.
See Also:
Constant Field Values
Constructor Detail

CollateralDataBean

public CollateralDataBean()
Method Detail

getCollateralID

public java.lang.Integer getCollateralID()
Gets the ID of this collateral.
Returns:
the collateral ID

getCommandContext

public CommandContext getCommandContext()
Gets the current command context
Specified by:
getCommandContext in interface 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 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 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

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

getName

public java.lang.String getName()
Gets the name of this collateral.
Specified by:
getName in interface CollateralSmartDataBean
Overrides:
getName in class CollateralAccessBean
Returns:
the collateral name

getRequestProperties

public TypedProperty getRequestProperties()
Gets the request properties that is currently being used.
Specified by:
getRequestProperties in interface 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

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 CollateralAccessBean
Returns:
the collateral URL link

populate

public void populate()
              throws java.lang.Exception
Populates this data bean that represents a single collateral in the database.
Specified by:
populate in interface SmartDataBean
Throws:
java.lang.Exception - Thrown when an error occurs during the population of this data bean.

setCollateralID

public void setCollateralID(java.lang.Integer newCollateralID)
Sets the ID of this collateral.
Parameters:
newCollateralID - the collateral ID

setCommandContext

public void setCommandContext(CommandContext context)
Sets the current command context.
Specified by:
setCommandContext in interface 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 CollateralAccessBean
Parameters:
newCustomerField1 - the customizable field 1
Returns:
void

setCustomerField2

public void setCustomerField2(java.lang.String newCustomerField2)
Sets the customizable field 2 of this collateral.
Overrides:
setCustomerField2 in class CollateralAccessBean
Parameters:
newCustomerField2 - the customizable field 2
Returns:
void

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

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

setName

public void setName(java.lang.String newName)
Sets the name of this collateral.
Overrides:
setName in class CollateralAccessBean
Parameters:
newName - the collateral name
Returns:
void

setRequestProperties

public void setRequestProperties(TypedProperty requestProperties)
Sets the request properties that is currently being used.
Specified by:
setRequestProperties in interface 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

setType

public void setType(java.lang.Integer newTypeID)
Sets the ID of the type that this collateral belongs to.
Overrides:
setType in class CollateralAccessBean
Parameters:
newTypeID - the collateral type ID
Returns:
void

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 CollateralAccessBean
Parameters:
newUrlLink - the collateral URL link
Returns:
void