com.ibm.commerce.marketingcenter.events.dbobjects
Class CpgnLog

java.lang.Object
  |
  +--com.ibm.commerce.marketingcenter.events.dbobjects.CpgnLog
All Implemented Interfaces:
MktgEventHandler, MktgLogEventHandler

public class CpgnLog
extends java.lang.Object
implements MktgLogEventHandler

This is the object that will persist the event into the CPGNLOG table.


Field Summary
 java.lang.String clcmpname
          Campaign name.
 java.lang.String clintvname
          Initiative name.
 java.lang.String clmpename
          MPE name.
 java.lang.String clmpetype
          MPE type name.
 java.lang.String clresults
          Comma-delimited list of recommendation ids for items recommended to the user.
 java.lang.String clshopsegments
          Comma-delimited list of segments that the shopper belonged to.
 java.lang.Integer cmp_id
          Campaign ID.
static java.lang.String COPYRIGHT
          IBM copyright notice field.
 java.lang.Integer intv_id
          Initiative ID.
 java.lang.Integer mpe_id
          MPE ID.
 java.lang.Integer mpet_id
          MPE type ID.
 java.lang.Integer storeent_id
          Store entity ID.
 java.lang.Long usrtraffic_id
          User traffid ID.
 
Constructor Summary
CpgnLog()
          Constructor for CpgnLog.
 
Method Summary
 void addEvent()
          This method will persist/update a record in the CPGNLOG table.
 void addEvent(java.util.Hashtable h)
          This method will persist/update a record in the CPGNLOG table.
 void addEvent(java.lang.Long userTrafficId, java.lang.Integer campaignId, java.lang.String campaignName, java.lang.Integer initiativeId, java.lang.String initiativeName, java.lang.Integer mpeTypeId, java.lang.String mpeTypeName, java.lang.Integer mpeId, java.lang.String mpeName, java.lang.Integer storeId, java.lang.String shopperSegmentList, java.lang.String recommendationList)
          This method will persist/update a record in the CPGNLOG table.
 void addEvent( TypedProperty tp)
          This method will persist/update a record in the CPGNLOG table.
 void addEvent( TypedProperty tp, java.lang.Integer storeIdentifier)
          This method will persist/update a record in the CPGNLOG table.
 java.lang.Integer getCampaignId()
          Gets the campaign ID recorded in the current event.
 java.lang.String getCampaignName()
          Gets the campaign name recorded in the current event.
 java.lang.Integer getInitiativeId()
          Gets the initiative ID recorded in the current event.
 java.lang.String getInitiativeName()
          Gets the initiative name recorded in the current event.
 java.lang.Integer getMpeId()
          Gets the MPE ID recorded in the current event.
 java.lang.String getMpeName()
          Gets the MPE name recorded in the current event.
 java.lang.String getMpeType()
          Gets the MPE type recorded in the current event.
 java.lang.Integer getMpeTypeId()
          Gets the MPE type ID recorded in the current event.
 java.lang.String getResults()
          Gets the campaign results recorded in the current event.
 java.lang.String getShopperSegments()
          Gets the campaign shopper segments recorded in the current event.
 java.lang.Integer getStoreId()
          Gets the store ID recorded in the current event.
 java.lang.Long getUserTrafficId()
          Gets the user traffic ID recorded in the current event.
 void persistEvent()
          Persists the current event by inserting the event details into the database.
 void setCampaignId(java.lang.Integer newCmp_id)
          Sets the campaign ID recorded in the current event.
 void setCampaignName(java.lang.String newClcmpname)
          Sets the campaign name recorded in the current event.
 void setInitiativeId(java.lang.Integer newIntv_id)
          Sets the initiative ID recorded in the current event.
 void setInitiativeName(java.lang.String newClintvname)
          Sets the initiative name recorded in the current event.
 void setMpeId(java.lang.Integer newMpe_id)
          Sets the MPE ID recorded in the current event.
 void setMpeName(java.lang.String newClmpename)
          Sets the MPE name recorded in the current event.
 void setMpeType(java.lang.String newClmpetype)
          Sets the MPE type recorded in the current event.
 void setMpeTypeId(java.lang.Integer newMpet_id)
          Sets the MPE type ID recorded in the current event.
 void setResults(java.lang.String newClresults)
          Sets the campaign results recorded in the current event.
 void setShopperSegments(java.lang.String newClshopsegments)
          Sets the campaign shopper segments recorded in the current event.
 void setStoreId(java.lang.Integer newStore_id)
          Sets the store ID recorded in the current event.
 void setUserTrafficId(java.lang.Long usrtrafficId)
          Sets the user traffic ID recorded in the current event.
 
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

usrtraffic_id

public java.lang.Long usrtraffic_id
User traffid ID.

cmp_id

public java.lang.Integer cmp_id
Campaign ID.

clcmpname

public java.lang.String clcmpname
Campaign name.

intv_id

public java.lang.Integer intv_id
Initiative ID.

clintvname

public java.lang.String clintvname
Initiative name.

mpet_id

public java.lang.Integer mpet_id
MPE type ID.

clmpetype

public java.lang.String clmpetype
MPE type name.

mpe_id

public java.lang.Integer mpe_id
MPE ID.

clmpename

public java.lang.String clmpename
MPE name.

storeent_id

public java.lang.Integer storeent_id
Store entity ID.

clshopsegments

public java.lang.String clshopsegments
Comma-delimited list of segments that the shopper belonged to.

clresults

public java.lang.String clresults
Comma-delimited list of recommendation ids for items recommended to the user.
Constructor Detail

CpgnLog

public CpgnLog()
Constructor for CpgnLog.
Method Detail

addEvent

public void addEvent()
This method will persist/update a record in the CPGNLOG table. If a a record is not found, one will be created with the counters set to 0. If a record exists, the view count is incremented. The caller must do all the setXXX prior to calling this.

addEvent

public void addEvent(TypedProperty tp)
This method will persist/update a record in the CPGNLOG table. If a a record is not found, one will be created with the counters set to 0. If a record exists, the view count is incremented.
Specified by:
addEvent in interface MktgLogEventHandler
Parameters:
tp - The TypedProperty that contains all the column=value pairs. The key name should be the same name as in the database table. The type should also be the same (e.g. Integer).

addEvent

public void addEvent(TypedProperty tp,
                     java.lang.Integer storeIdentifier)
This method will persist/update a record in the CPGNLOG table. If a a record is not found, one will be created with the counters set to 0. If a record exists, the view count is incremented.
Specified by:
addEvent in interface MktgLogEventHandler
Parameters:
tp - The TypedProperty that contains all the column=value pairs. The key name should be the same name as in the database table. The type should also be the same (e.g. Integer).
storeIdentifier - The WCS store Id

addEvent

public void addEvent(java.lang.Long userTrafficId,
                     java.lang.Integer campaignId,
                     java.lang.String campaignName,
                     java.lang.Integer initiativeId,
                     java.lang.String initiativeName,
                     java.lang.Integer mpeTypeId,
                     java.lang.String mpeTypeName,
                     java.lang.Integer mpeId,
                     java.lang.String mpeName,
                     java.lang.Integer storeId,
                     java.lang.String shopperSegmentList,
                     java.lang.String recommendationList)
This method will persist/update a record in the CPGNLOG table. If a a record is not found, one will be created with the counters set to 0. If a record exists, the view count is incremented.
Parameters:
userTrafficId - the user traffic ID
campaignId - the campaign ID
campaignName - the name of the campaign
initiativeId - the initiative ID
initiativeName - the name of the initiative
mpeTypeId - the MPE type ID
mpeTypeName - the name of the MPE type
mpeId - the MPE ID
mpeName - the name of the MPE
storeId - the store ID
shopperSegmentList - the shopper segment list
recommendationList - the recommendation list

addEvent

public void addEvent(java.util.Hashtable h)
This method will persist/update a record in the CPGNLOG table. If a a record is not found, one will be created with the counters set to 0. If a record exists, the view count is incremented.
Specified by:
addEvent in interface MktgLogEventHandler
Parameters:
h - The Hashtable that contains all the column=value pairs. The key name should be the same name as in the database table. The type should also be the same (e.g. Integer).

getCampaignId

public java.lang.Integer getCampaignId()
Gets the campaign ID recorded in the current event.
Returns:
campaign ID

getCampaignName

public java.lang.String getCampaignName()
Gets the campaign name recorded in the current event.
Returns:
campaign name

getInitiativeId

public java.lang.Integer getInitiativeId()
Gets the initiative ID recorded in the current event.
Returns:
initiative ID

getInitiativeName

public java.lang.String getInitiativeName()
Gets the initiative name recorded in the current event.
Returns:
initiative name

getMpeId

public java.lang.Integer getMpeId()
Gets the MPE ID recorded in the current event.
Returns:
MPE ID

getMpeName

public java.lang.String getMpeName()
Gets the MPE name recorded in the current event.
Returns:
MPE name

getMpeType

public java.lang.String getMpeType()
Gets the MPE type recorded in the current event.
Returns:
MPE type

getMpeTypeId

public java.lang.Integer getMpeTypeId()
Gets the MPE type ID recorded in the current event.
Returns:
MPE type ID

getResults

public java.lang.String getResults()
Gets the campaign results recorded in the current event.
Returns:
campaign results

getShopperSegments

public java.lang.String getShopperSegments()
Gets the campaign shopper segments recorded in the current event.
Returns:
campaign shopper segments

getStoreId

public java.lang.Integer getStoreId()
Gets the store ID recorded in the current event.
Returns:
store ID

getUserTrafficId

public java.lang.Long getUserTrafficId()
Gets the user traffic ID recorded in the current event.
Returns:
user traffic ID

persistEvent

public void persistEvent()
Persists the current event by inserting the event details into the database.

setCampaignId

public void setCampaignId(java.lang.Integer newCmp_id)
Sets the campaign ID recorded in the current event.
Parameters:
newCmp_id - campaign ID

setCampaignName

public void setCampaignName(java.lang.String newClcmpname)
Sets the campaign name recorded in the current event.
Parameters:
newClcmpname - campaign name

setInitiativeId

public void setInitiativeId(java.lang.Integer newIntv_id)
Sets the initiative ID recorded in the current event.
Parameters:
newIntv_id - initiative ID

setInitiativeName

public void setInitiativeName(java.lang.String newClintvname)
Sets the initiative name recorded in the current event.
Parameters:
newClintvname - initiative name

setMpeId

public void setMpeId(java.lang.Integer newMpe_id)
Sets the MPE ID recorded in the current event.
Parameters:
newMpe_id - MPE ID

setMpeName

public void setMpeName(java.lang.String newClmpename)
Sets the MPE name recorded in the current event.
Parameters:
newClmpename - MPE name

setMpeType

public void setMpeType(java.lang.String newClmpetype)
Sets the MPE type recorded in the current event.
Parameters:
newClmpetype - MPE type

setMpeTypeId

public void setMpeTypeId(java.lang.Integer newMpet_id)
Sets the MPE type ID recorded in the current event.
Parameters:
newMpet_id - MPE type ID

setResults

public void setResults(java.lang.String newClresults)
Sets the campaign results recorded in the current event.
Parameters:
newClresults - campaign results

setShopperSegments

public void setShopperSegments(java.lang.String newClshopsegments)
Sets the campaign shopper segments recorded in the current event.
Parameters:
newClshopsegments - campaign shopper segments

setStoreId

public void setStoreId(java.lang.Integer newStore_id)
Sets the store ID recorded in the current event.
Parameters:
newStore_id - store ID

setUserTrafficId

public void setUserTrafficId(java.lang.Long usrtrafficId)
Sets the user traffic ID recorded in the current event.
Parameters:
usrtrafficId - user traffic ID