com.ibm.commerce.marketing.beans
Class CollateralDataBean

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

Fields inherited from interface com.ibm.commerce.beans.InputDataBean
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString
 
Fields inherited from interface com.ibm.commerce.beans.SmartDataBean
COPYRIGHT
 
Constructor Summary
CollateralDataBean()
           
 
Method Summary
 java.lang.Integer getCollateralID()
          Returns the collateral id (primary key from the COLLATERAL table)
 CommandContext getCommandContext()
          Returns the current command's context
 java.lang.String getCustomerField1()
          Returns customer field 1 from the COLLATERAL table
 java.lang.String getCustomerField2()
          Returns customer field 2 from the COLLATERAL table
 java.lang.String getDescriptionCustomerField1()
          Returns customer field 1 from the COLLDESC table
 java.lang.String getDescriptionCustomerField2()
          Returns customer field 2 from the COLLDESC table
 java.lang.Integer getLanguageId()
          Returns the language id This is the language in which to return the data
 java.lang.String getLocation()
          Returns the location This is the name of the image or flash file
 java.lang.String getMarketingText()
          Returns the marketing text
 java.lang.String getName()
          Returns the name of the ad copy
 TypedProperty getRequestProperties()
          Returns the request properties
 java.lang.Integer getStoreID()
          Returns the store id
 java.lang.Integer getTypeID()
          Returns the type id from the COLLTYPE table
 java.lang.String getTypeName()
          Returns the name of the type of this ad copy
 java.lang.String getUrlLink()
          Returns the url link
 void populate()
          Populates the data for this databean It requires that the collateral id and the language id are set
 void setCollateralID(java.lang.Integer newCollateralID)
          Sets the id of the collateral to find
 void setCommandContext(CommandContext context)
          Sets the command context
 void setCustomerField1(java.lang.String newCustomerField1)
          Sets customer field 1
 void setCustomerField2(java.lang.String newCustomerField2)
          Sets customer field 2
 void setDescriptionCustomerField1(java.lang.String newDescriptionCustomerField1)
          Sets customer field 1 from the COLLDESC table
 void setDescriptionCustomerField2(java.lang.String newDescriptionCustomerField2)
          Sets customer field 2 from the COLLDESC table
 void setLanguageId(java.lang.Integer newLanguageId)
          Sets the language id to specify in which language to return the ad copy
 void setLocation(java.lang.String newLocation)
          Sets the location
 void setMarketingText(java.lang.String newMarketingText)
          Sets the marketing text
 void setName(java.lang.String newName)
          Sets the name of the ad copy
 void setRequestProperties(TypedProperty requestProperties)
          Sets the request properties
 void setStoreID(java.lang.Integer newStoreID)
          Sets the store id
 void setType(java.lang.Integer newTypeID)
          Sets the type of the ad copy
 void setTypeName(java.lang.String newTypeName)
          Sets the type name
 void setUrlLink(java.lang.String newUrlLink)
          Sets the url link
 
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
 

Constructor Detail

CollateralDataBean

public CollateralDataBean()
Method Detail

getCollateralID

public java.lang.Integer getCollateralID()
Returns the collateral id (primary key from the COLLATERAL table)
Returns:
java.lang.Integer

getCommandContext

public CommandContext getCommandContext()
Returns the current command's context
Specified by:
getCommandContext in interface SmartDataBean
Returns:
com.ibm.commerce.command.CommandContext

getCustomerField1

public java.lang.String getCustomerField1()
Returns customer field 1 from the COLLATERAL table
Specified by:
getCustomerField1 in interface CollateralSmartDataBean
Overrides:
getCustomerField1 in class CollateralAccessBean
Returns:
java.lang.String

getCustomerField2

public java.lang.String getCustomerField2()
Returns customer field 2 from the COLLATERAL table
Specified by:
getCustomerField2 in interface CollateralSmartDataBean
Overrides:
getCustomerField2 in class CollateralAccessBean
Returns:
java.lang.String

getDescriptionCustomerField1

public java.lang.String getDescriptionCustomerField1()
Returns customer field 1 from the COLLDESC table
Specified by:
getDescriptionCustomerField1 in interface CollateralSmartDataBean
Returns:
java.lang.String

getDescriptionCustomerField2

public java.lang.String getDescriptionCustomerField2()
Returns customer field 2 from the COLLDESC table
Specified by:
getDescriptionCustomerField2 in interface CollateralSmartDataBean
Returns:
java.lang.String

getLanguageId

public java.lang.Integer getLanguageId()
Returns the language id This is the language in which to return the data
Returns:
java.lang.Integer

getLocation

public java.lang.String getLocation()
Returns the location This is the name of the image or flash file
Specified by:
getLocation in interface CollateralSmartDataBean
Returns:
java.lang.String

getMarketingText

public java.lang.String getMarketingText()
Returns the marketing text
Specified by:
getMarketingText in interface CollateralSmartDataBean
Returns:
java.lang.String

getName

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

getRequestProperties

public TypedProperty getRequestProperties()
Returns the request properties
Specified by:
getRequestProperties in interface InputDataBean
Returns:
com.ibm.commerce.datatype.TypedProperty

getStoreID

public java.lang.Integer getStoreID()
Returns the store id
Returns:
java.lang.Integer

getTypeID

public java.lang.Integer getTypeID()
Returns the type id from the COLLTYPE table
Specified by:
getTypeID in interface CollateralSmartDataBean
Returns:
java.lang.Integer

getTypeName

public java.lang.String getTypeName()
Returns the name of the type of this ad copy
Specified by:
getTypeName in interface CollateralSmartDataBean
Returns:
java.lang.String

getUrlLink

public java.lang.String getUrlLink()
Returns the url link
Specified by:
getUrlLink in interface CollateralSmartDataBean
Overrides:
getUrlLink in class CollateralAccessBean
Returns:
java.lang.String

populate

public void populate()
              throws java.lang.Exception
Populates the data for this databean It requires that the collateral id and the language id are set
Specified by:
populate in interface SmartDataBean
Returns:
void

setCollateralID

public void setCollateralID(java.lang.Integer newCollateralID)
Sets the id of the collateral to find
Parameters:
newCollateralId - java.lang.Integer

setCommandContext

public void setCommandContext(CommandContext context)
Sets the command context
Specified by:
setCommandContext in interface SmartDataBean
Parameters:
aCommandContext - com.ibm.commerce.command.CommandContext

setCustomerField1

public void setCustomerField1(java.lang.String newCustomerField1)
Sets customer field 1
Overrides:
setCustomerField1 in class CollateralAccessBean
Parameters:
newCustomerField1 - java.lang.String

setCustomerField2

public void setCustomerField2(java.lang.String newCustomerField2)
Sets customer field 2
Overrides:
setCustomerField2 in class CollateralAccessBean
Parameters:
newCustomerField2 - java.lang.String

setDescriptionCustomerField1

public void setDescriptionCustomerField1(java.lang.String newDescriptionCustomerField1)
Sets customer field 1 from the COLLDESC table
Parameters:
newDescriptionCustomerField1 - java.lang.String

setDescriptionCustomerField2

public void setDescriptionCustomerField2(java.lang.String newDescriptionCustomerField2)
Sets customer field 2 from the COLLDESC table
Parameters:
newDescriptionCustomerField2 - java.lang.String

setLanguageId

public void setLanguageId(java.lang.Integer newLanguageId)
Sets the language id to specify in which language to return the ad copy
Parameters:
newLanguageId - java.lang.Integer

setLocation

public void setLocation(java.lang.String newLocation)
Sets the location
Parameters:
newLocation - java.lang.String

setMarketingText

public void setMarketingText(java.lang.String newMarketingText)
Sets the marketing text
Parameters:
newMarketingText - java.lang.String

setName

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

setRequestProperties

public void setRequestProperties(TypedProperty requestProperties)
Sets the request properties
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
aParam - com.ibm.commerce.datatype.TypedProperty

setStoreID

public void setStoreID(java.lang.Integer newStoreID)
Sets the store id
Parameters:
newStoreId - java.lang.Integer

setType

public void setType(java.lang.Integer newTypeID)
Sets the type of the ad copy
Overrides:
setType in class CollateralAccessBean
Parameters:
newType - java.lang.Integer

setTypeName

public void setTypeName(java.lang.String newTypeName)
Sets the type name
Parameters:
newTypeName - java.lang.String

setUrlLink

public void setUrlLink(java.lang.String newUrlLink)
Sets the url link
Overrides:
setUrlLink in class CollateralAccessBean
Parameters:
newUrlLink - java.lang.String