java.lang.Object | +--com.ibm.commerce.beans.InputDataBeanImpl | +--com.ibm.commerce.beans.SmartDataBeanImpl | +--com.ibm.commerce.marketingcenter.campaign.beans.CollateralListDataBean
This data bean represents a list of ad copy to be displayed in the ad copy
list. Each row in the list is represented by a CollateralDataBean
object.
Field Summary | |
---|---|
protected
CollateralDataBean[] |
collateralList An array of the collateral data bean. |
static java.lang.String |
COPYRIGHT IBM copyright notice field. |
Fields inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
commandContext |
Fields inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
requestProperties |
Fields inherited from interface com.ibm.commerce.beans. DataBean |
emptyString |
Constructor Summary | |
---|---|
CollateralListDataBean() Constructor for CollateralListDataBean. |
Method Summary | |
---|---|
CollateralDataBean[] |
getCollateralList() Gets the array of the collateral data bean, they represent all collateral entries in the database. |
CollateralDataBean |
getCollateralList(int index) Gets an entry in the collateral data bean, given the index of the array. |
java.lang.Integer |
getLanguageID() Gets the ID of the current language that is in use. |
java.util.List |
getNames() Gets all the collateral identifiers that represent this list data bean, in a List object. |
java.lang.String |
getOrderBy() Gets the value that represents the collateral list column to be sorted, in the form of the value in the order by clause to be used by the EJB finder. |
java.lang.Integer |
getStoreID() Gets the ID of the store that is currently logged on to. |
boolean |
isListAll() Gets the boolean value that determines whether to show all collateral in the list or not. |
void |
populate() Populates this data bean that represents the collaterals in the database. |
void |
setCollateralList(
CollateralDataBean[] newCollateralList) Sets the array of the collateral data bean, they represent all collateral entries in the database. |
void |
setLanguageID(java.lang.Integer newLanguageID) Sets the ID of the current language that is in use. |
void |
setListAll(boolean newListAll) Sets the boolean value that determines whether to show all collateral in the list or not. |
void |
setNames(java.util.List newNames) Sets all the collateral identifiers that represent this list data bean, in a List object. |
void |
setOrderBy(java.lang.String newOrderBy) Sets the value that represents the collateral list column to be sorted, in the form of the value in the order by clause to be used by the EJB finder. |
void |
setStoreID(java.lang.Integer newStoreID) Sets the ID of the store that is currently logged on to. |
Methods inherited from class com.ibm.commerce.beans. SmartDataBeanImpl |
fulfills,
getCommandContext,
getResources,
setCommandContext |
Methods inherited from class com.ibm.commerce.beans. InputDataBeanImpl |
getRequestProperties,
setRequestProperties |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll,
toString, wait, wait, wait |
Methods inherited from interface com.ibm.commerce.beans. InputDataBean |
getRequestProperties,
setRequestProperties |
Field Detail |
---|
public static final java.lang.String COPYRIGHT
protected CollateralDataBean[] collateralList
Constructor Detail |
---|
public CollateralListDataBean()
Method Detail |
---|
public CollateralDataBean[] getCollateralList()
getCollateralList
in interface
CollateralListSmartDataBean
CollateralDataBean
objectpublic CollateralDataBean getCollateralList(int index)
getCollateralList
in interface
CollateralListSmartDataBean
index
- the index of the collateral data bean arrayCollateralDataBean
objectpublic java.lang.Integer getLanguageID()
public java.util.List getNames()
List
object.
public java.lang.String getOrderBy()
public java.lang.Integer getStoreID()
getStoreID
in interface
CollateralListSmartDataBean
public boolean isListAll()
public void populate() throws java.lang.Exception
populate
in interface
SmartDataBean
populate
in class
SmartDataBeanImpl
java.lang.Exception
- Thrown when an error occurs during the
population of this data bean.public void setCollateralList(CollateralDataBean[] newCollateralList)
newCollateralList
- an array of
CollateralDataBean
objectpublic void setLanguageID(java.lang.Integer newLanguageID)
newLanguageID
- the language IDpublic void setListAll(boolean newListAll)
newListAll
- true if shows all collateral in the list; false
otherwise.public void setNames(java.util.List newNames)
List
object.
newNames
- list of all collateral
identifierspublic void setOrderBy(java.lang.String newOrderBy)
newOrderBy
- the value of the sorted column in the collateral
listpublic void setStoreID(java.lang.Integer newStoreID)
newStoreID
- the current store ID