com.ibm.commerce.marketingcenter.campaign.beans
Class CollateralListDataBean

java.lang.Object
  |
  +--com.ibm.commerce.beans.InputDataBeanImpl
        |
        +--com.ibm.commerce.beans.SmartDataBeanImpl
              |
              +--com.ibm.commerce.marketingcenter.campaign.beans.CollateralListDataBean
All Implemented Interfaces:
CollateralListInputDataBean, CollateralListSmartDataBean, DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class CollateralListDataBean
extends SmartDataBeanImpl
implements CollateralListInputDataBean, CollateralListSmartDataBean

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.

See Also:
Serialized Form

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
IBM copyright notice field.
See Also:
Constant Field Values

collateralList

protected CollateralDataBean[] collateralList
An array of the collateral data bean.
Constructor Detail

CollateralListDataBean

public CollateralListDataBean()
Constructor for CollateralListDataBean. This method creates a collateral list bean where the list of collateral is initialized to a zero length array.
Method Detail

getCollateralList

public CollateralDataBean[] getCollateralList()
Gets the array of the collateral data bean, they represent all collateral entries in the database.
Specified by:
getCollateralList in interface CollateralListSmartDataBean
Returns:
an array of CollateralDataBean object

getCollateralList

public CollateralDataBean getCollateralList(int index)
Gets an entry in the collateral data bean, given the index of the array.
Specified by:
getCollateralList in interface CollateralListSmartDataBean
Parameters:
index - the index of the collateral data bean array
Returns:
an entry in the array of CollateralDataBean object

getLanguageID

public java.lang.Integer getLanguageID()
Gets the ID of the current language that is in use.
Returns:
the language ID

getNames

public java.util.List getNames()
Gets all the collateral identifiers that represent this list data bean, in a List object.
Returns:
list of all collateral identifiers

getOrderBy

public 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.
Returns:
the value of the sorted column in the collateral list

getStoreID

public java.lang.Integer getStoreID()
Gets the ID of the store that is currently logged on to.
Specified by:
getStoreID in interface CollateralListSmartDataBean
Returns:
the current store ID

isListAll

public boolean isListAll()
Gets the boolean value that determines whether to show all collateral in the list or not.
Returns:
true if shows all collateral in the list; false otherwise.

populate

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

setCollateralList

public void setCollateralList(CollateralDataBean[] newCollateralList)
Sets the array of the collateral data bean, they represent all collateral entries in the database.
Parameters:
newCollateralList - an array of CollateralDataBean object

setLanguageID

public void setLanguageID(java.lang.Integer newLanguageID)
Sets the ID of the current language that is in use.
Parameters:
newLanguageID - the language ID

setListAll

public void setListAll(boolean newListAll)
Sets the boolean value that determines whether to show all collateral in the list or not.
Parameters:
newListAll - true if shows all collateral in the list; false otherwise.

setNames

public void setNames(java.util.List newNames)
Sets all the collateral identifiers that represent this list data bean, in a List object.
Parameters:
newNames - list of all collateral identifiers

setOrderBy

public 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.
Parameters:
newOrderBy - the value of the sorted column in the collateral list

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