com.ibm.commerce.marketingcenter.events.databeans
Class CampaignStatisticsListDataBean

java.lang.Object
  |
  +--com.ibm.commerce.marketingcenter.events.databeans.CampaignStatisticsListDataBean
All Implemented Interfaces:
DataBean, InputDataBean, java.io.Serializable, SmartDataBean

public class CampaignStatisticsListDataBean
extends java.lang.Object
implements SmartDataBean

This class accesses all the entries of the campaign statistics in the database, where each row is represented by a CampaignStatisticsBean.

See Also:
Serialized Form

Field Summary
protected  CommandContext commandContext
          Current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
protected  java.lang.Integer intv_id
          Initiative ID associated with all the statistics in this bean.
protected  java.lang.Integer mpe_id
          Marketing page element ID associated with all the statistics in this bean.
protected  java.lang.String orderby
          Order by value to be used as the order by parameter in the EJB finder.
static java.lang.String ORDERBY_CLICKS
          Name for database column CLICKS used in the EJB finder to perform sorting on the list.
static java.lang.String ORDERBY_MPENAME
          Name for database column MPENAME used in the EJB finder to perform sorting on the list.
static java.lang.String ORDERBY_VIEWS
          Name for database column VIEWS used in the EJB finder to perform sorting on the list.
protected  TypedProperty requestProperties
          The request properties object associated with the data bean.
protected   CampaignStatisticsAccessBean[] statsAccessBeanList
          Array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.
protected   CampaignStatisticsBean[] statsDataBeanList
          Array of CampaignStatisticsBean objects that represents a row in the list, specified by the given index.
 
Fields inherited from interface com.ibm.commerce.beans. DataBean
emptyString
 
Constructor Summary
CampaignStatisticsListDataBean()
          Constructor for CampaignStatisticsListDataBean.
 
Method Summary
  CommandContext getCommandContext()
          Gets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
 java.lang.Integer getIntv_id()
          Gets the initiative ID associated with all the statistics in this bean.
 java.lang.Integer getMpe_id()
          Gets the marketing page element ID associated with all the statistics in this bean.
 java.lang.String getOrderby()
          Gets the order by value to be used as the order by parameter in the EJB finder.
  TypedProperty getRequestProperties()
          Gets the requestProperties associated with the data bean.
  CampaignStatisticsAccessBean[] getStatsAccessBeanList()
          Gets the array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.
  CampaignStatisticsBean[] getStatsDataBeanList()
          Gets the array of CampaignStatisticsBean objects that represents all the statistics in the list.
  CampaignStatisticsBean getStatsDataBeanList(int i)
          Gets an entry in the array of CampaignStatisticsBean objects that represents a row in the list, specified by the given index.
 void populate()
          Populate the databean that includes all the statistics found.
 void setCommandContext( CommandContext cmdContext)
          Sets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
 void setIntv_id(java.lang.Integer newIntv_id)
          Sets the initiative ID associated with all the statistics in this bean, in EJB attribute type.
 void setIntv_id(java.lang.String newIntv_id)
          Sets the initiative ID associated with all the statistics in this bean.
 void setMpe_id(java.lang.Integer newMpe_id)
          Sets the marketing page element ID associated with all the statistics in this bean, in EJB attribute type.
 void setMpe_id(java.lang.String newMpe_id)
          Sets the marketing page element ID associated with all the statistics in this bean.
 void setOrderby(java.lang.String newOrderby)
          Sets the order by value to be used as the order by parameter in the EJB finder.
 void setRequestProperties( TypedProperty param)
          Sets the requestProperties associated with the data bean.
 void setStatsAccessBeanList( CampaignStatisticsAccessBean[] newStatsAccessBeanList)
          Sets the array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.
 void setStatsDataBeanList( CampaignStatisticsBean[] newStatsDataBeanList)
          Sets the array of CampaignStatisticsBean objects that represents all the statistics in the list.
 
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

mpe_id

protected java.lang.Integer mpe_id
Marketing page element ID associated with all the statistics in this bean.

intv_id

protected java.lang.Integer intv_id
Initiative ID associated with all the statistics in this bean.

orderby

protected java.lang.String orderby
Order by value to be used as the order by parameter in the EJB finder.

requestProperties

protected TypedProperty requestProperties
The request properties object associated with the data bean.

commandContext

protected CommandContext commandContext
Current command context that is used to retrieve the runtime attribute like the store ID and the member ID.

statsDataBeanList

protected CampaignStatisticsBean[] statsDataBeanList
Array of CampaignStatisticsBean objects that represents a row in the list, specified by the given index.

statsAccessBeanList

protected CampaignStatisticsAccessBean[] statsAccessBeanList
Array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.

ORDERBY_MPENAME

public static final java.lang.String ORDERBY_MPENAME
Name for database column MPENAME used in the EJB finder to perform sorting on the list.
See Also:
Constant Field Values

ORDERBY_VIEWS

public static final java.lang.String ORDERBY_VIEWS
Name for database column VIEWS used in the EJB finder to perform sorting on the list.
See Also:
Constant Field Values

ORDERBY_CLICKS

public static final java.lang.String ORDERBY_CLICKS
Name for database column CLICKS used in the EJB finder to perform sorting on the list.
See Also:
Constant Field Values
Constructor Detail

CampaignStatisticsListDataBean

public CampaignStatisticsListDataBean()
Constructor for CampaignStatisticsListDataBean.
Method Detail

getCommandContext

public CommandContext getCommandContext()
Gets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
Specified by:
getCommandContext in interface SmartDataBean
Returns:
the current command context

getIntv_id

public java.lang.Integer getIntv_id()
Gets the initiative ID associated with all the statistics in this bean.
Returns:
initiative ID

getMpe_id

public java.lang.Integer getMpe_id()
Gets the marketing page element ID associated with all the statistics in this bean.
Returns:
marketing page element ID

getOrderby

public java.lang.String getOrderby()
Gets the order by value to be used as the order by parameter in the EJB finder.
Returns:
order by value

getRequestProperties

public TypedProperty getRequestProperties()
Gets the requestProperties associated with the data bean.
Specified by:
getRequestProperties in interface InputDataBean
Returns:
The set of properties passed to the JSP page that invokes this data bean.

getStatsAccessBeanList

public CampaignStatisticsAccessBean[] getStatsAccessBeanList()
Gets the array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.
Returns:
an array of CampaignStatisticsAccessBean objects

getStatsDataBeanList

public CampaignStatisticsBean[] getStatsDataBeanList()
Gets the array of CampaignStatisticsBean objects that represents all the statistics in the list.
Returns:
an array of CampaignStatisticsBean objects

getStatsDataBeanList

public CampaignStatisticsBean getStatsDataBeanList(int i)
Gets an entry in the array of CampaignStatisticsBean objects that represents a row in the list, specified by the given index.
Parameters:
i - index of the array
Returns:
a CampaignStatisticsBean object

populate

public void populate()
              throws java.lang.Exception
Populate the databean that includes all the statistics found.
Specified by:
populate in interface SmartDataBean
Throws:
java.lang.Exception - Thrown whenever an exception is encountered.

setCommandContext

public void setCommandContext(CommandContext cmdContext)
Sets the current command context that is used to retrieve the runtime attribute like the store ID and the member ID.
Specified by:
setCommandContext in interface SmartDataBean
Parameters:
cmdContext - the current command context

setIntv_id

public void setIntv_id(java.lang.Integer newIntv_id)
Sets the initiative ID associated with all the statistics in this bean, in EJB attribute type.
Parameters:
newIntv_id - initiative ID

setIntv_id

public void setIntv_id(java.lang.String newIntv_id)
Sets the initiative ID associated with all the statistics in this bean.
Parameters:
newIntv_id - initiative ID

setMpe_id

public void setMpe_id(java.lang.Integer newMpe_id)
Sets the marketing page element ID associated with all the statistics in this bean, in EJB attribute type.
Parameters:
newMpe_id - marketing page element ID

setMpe_id

public void setMpe_id(java.lang.String newMpe_id)
Sets the marketing page element ID associated with all the statistics in this bean.
Parameters:
newMpe_id - marketing page element ID

setOrderby

public void setOrderby(java.lang.String newOrderby)
Sets the order by value to be used as the order by parameter in the EJB finder.

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets the requestProperties associated with the data bean.
Specified by:
setRequestProperties in interface InputDataBean
Parameters:
param - The set of properties passed to the JSP page that invokes this data bean.

setStatsAccessBeanList

public void setStatsAccessBeanList(CampaignStatisticsAccessBean[] newStatsAccessBeanList)
Sets the array of CampaignStatisticsAccessBean objects that represents all the statistics in the list.
Parameters:
newStatsAccessBeanList - an array of CampaignStatisticsAccessBean objects

setStatsDataBeanList

public void setStatsDataBeanList(CampaignStatisticsBean[] newStatsDataBeanList)
Sets the array of CampaignStatisticsBean objects that represents all the statistics in the list.
Parameters:
newStatsDataBeanList - an array of CampaignStatisticsBean objects