com.ibm.commerce.couponpromotion.objects
Class CouponPromotionAccessBean

java.lang.Object
  |
  +--com.ibm.ivj.ejb.runtime.AbstractAccessBean
        |
        +--com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
              |
              +--com.ibm.commerce.couponpromotion.objects.CouponPromotionAccessBean
All Implemented Interfaces:
CouponPromotionAccessBeanData, java.io.Serializable

public class CouponPromotionAccessBean
extends com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
implements CouponPromotionAccessBeanData

This bean provides access to the CPPMN table.

The following is a description of this table:

This table gives the details of what a promotion is, and reference to its purchase, validity and discount conditions.

See Also:
Serialized Form

Fields inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
DEFAULT_NAMESERVICE_PROVIDER_URL, DEFAULT_NAMESERVICE_TYPE, ejbRef
 
Constructor Summary
CouponPromotionAccessBean()
          Default constructor.
CouponPromotionAccessBean(javax.ejb.EJBObject newCouponPromotionEJB)
          This method calls the ejbCreate method to create an entry in CPPMN table.
CouponPromotionAccessBean(java.lang.Integer newInitiativeId, java.lang.Integer newValidityId, java.lang.String newPurchaseCondType, java.lang.Integer newNumSeenAllowed, java.lang.String newPromoDispType, java.lang.Integer newNumUseAllowed, java.lang.Integer newTotalNumOffer, java.lang.String newCurrency, java.lang.String newPromoName, java.lang.String newPromoDesc, java.sql.Timestamp newStartTime, java.sql.Timestamp newEndTime, java.lang.Integer newStoreId)
          This method calls ejbCreate method to create an entry in CPPMN table.
 
Method Summary
 void commitCopyHelper()
          Update(flush) data to the EJBObject (persistent storage).
 CouponPromotionAccessBean findByCouponPromotionId(java.lang.Integer couponPromotionId)
          This method executes the following SQL Script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.CPPMN_ID = ?
 java.util.Enumeration findByEndDateBefore(java.sql.Timestamp endDate)
          This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.ENDDATE < ?.
 java.util.Enumeration findByInitiativeId(java.lang.Integer initiativeId)
          This method executes the following SQL Script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.INITIATIVE_ID = ?
 CouponPromotionAccessBean findByPromoNameStoreId(java.lang.String couponPromotionName, java.lang.Integer storeId)
          This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.CPPMNNAME = ? AND T1.STOREENT_ID = ?
 java.util.Enumeration findByStoreIdStatus(java.lang.Integer storeId, java.lang.String status)
          This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.STOREENT_ID = ? AND T1.STATUS = ?
 boolean fulfills(java.lang.Long userId, java.lang.String relationship)
          This method is used for access control.
 java.lang.Integer getCouponPromotionId()
          This method provides access to the CPPMN.CPPMN_ID column of DB2 type INTEGER NOT NULL.
 java.sql.Timestamp getCreationTime()
          This method provides access to the CPPMN.CREATIONTIME column of DB2 type TIMESTAMP NULL.
 java.lang.String getCurrency()
          This method provides access to the CPPMN.SETCCURR column of DB2 type CHAR(3) NULL.
 java.lang.Integer getEarlyBirdLimit()
          This method provides access to the CPPMN.EARLYBIRDLIMIT column of DB2 type INTEGER NULL.
 java.sql.Timestamp getEndDate()
          This method provides access to the CPPMN.ENDDATE column of DB2 type TIMESTAMP NULL.
 java.lang.String getField1()
          This method provides access to the CPPMN.FIELD1 column of DB2 type VARCHAR(64) NULL.
 java.lang.Integer getInitiativeId()
          This method provides access to the CPPMN.INITIATIVE_ID column of DB2 type INTEGER NULL.
 java.lang.Integer getNumOffered()
          This method provides access to the CPPMN.NUMOFFERED column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getNumSeenAllowed()
          This method provides access to the CPPMN.NUMSEENALLOWED column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getNumUseAllowed()
          This method provides access to the CPPMN.NUMUSEALLOWED column of DB2 type INTEGER NOT NULL.
 java.lang.Long getOwner()
          This method is used for access control.
 java.lang.String getPromoDispType()
          This method provides access to the CPPMN.PROMODISPTYPE column of DB2 type CHAR(4) NOT NULL.
 java.lang.String getPromotionDescription()
          This method provides access to the CPPMN.CPPMNDESC column of DB2 type CHAR(254) NULL.
 java.lang.String getPromotionName()
          This method provides access to the CPPMN.CPPMNNAME column of DB2 type CHAR(64) NOT NULL.
 java.lang.String getPurchaseCondType()
          This method provides access to the CPPMN.PURCHASECONDTYPE column of DB2 type CHAR(4) NOT NULL.
 java.sql.Timestamp getStartDate()
          This method provides access to the CPPMN.STARTDATE column of DB2 type TIMESTAMP NOT NULL.
 java.lang.String getStatus()
          This method provides access to the CPPMN.STATUS column of DB2 type CHAR(1) NOT NULL.
 java.lang.Integer getStoreId()
          This method provides access to the CPPMN.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getTotalNumOffer()
          This method provides access to the CPPMN.TOTALNUMOFFER column of DB2 type INTEGER NOT NULL.
 java.lang.Integer getValidityId()
          This method provides access to the CPPMN.CPPMNVAL_ID column of DB2 type INTEGER NULL.
 void refreshCopyHelper()
          Load data from the EJBObject.
 void setCouponPromotionId(java.lang.Integer couponPromotionId)
          This method provides access to the CPPMN.CPPMN_ID column of DB2 type INTEGER NOT NULL.
 void setCreationTime(java.sql.Timestamp creationTime)
          This method provides access to the CPPMN.CREATIONTIME column of DB2 type TIMESTAMP NULL.
 void setCurrency(java.lang.String currency)
          This method provides access to the CPPMN.SETCCURR column of DB2 type CHAR(3) NULL.
 void setEarlyBirdLimit(java.lang.Integer earlyBirdLimit)
          This method provides access to the CPPMN.EARLYBIRDLIMIT column of DB2 type INTEGER NULL.
 void setEndDate(java.sql.Timestamp endDate)
          This method provides access to the CPPMN.ENDDATE column of DB2 type TIMESTAMP NULL.
 void setField1(java.lang.String field1)
          This method provides access to the CPPMN.FIELD1 column of DB2 type VARCHAR(64) NULL.
 void setInitiativeId(java.lang.Integer initiativeId)
          This method provides access to the CPPMN.INITIATIVE_ID column of DB2 type INTEGER NULL.
 void setInitKey_couponPromotionId(java.lang.Integer couponPromotionId)
          Set the primary key for this object
 void setNumOffered(java.lang.Integer numOffered)
          This method provides access to the CPPMN.NUMOFFERED column of DB2 type INTEGER NOT NULL.
 void setNumSeenAllowed(java.lang.Integer numTimesPromotionOfferedToUser)
          This method provides access to the CPPMN.NUMSEENALLOWED column of DB2 type INTEGER NOT NULL.
 void setNumUseAllowed(java.lang.Integer numUsesAllowed)
          This method provides access to the CPPMN.NUMUSEALLOWED column of DB2 type INTEGER NOT NULL.
 void setPromoDispType(java.lang.String promoDisplayType)
          This method provides access to the CPPMN.PROMODISPTYPE column of DB2 type CHAR(4) NOT NULL.
 void setPromotionDescription(java.lang.String promotionDescription)
          This method provides access to the CPPMN.CPPMNDESC column of DB2 type CHAR(254) NULL.
 void setPromotionName(java.lang.String promotionName)
          This method provides access to the CPPMN.CPPMNNAME column of DB2 type CHAR(64) NOT NULL.
 void setPurchaseCondType(java.lang.String purchaseCondType)
          This method provides access to the CPPMN.PURCHASECONDTYPE column of DB2 type CHAR(4) NOT NULL.
 void setStartDate(java.sql.Timestamp startDate)
          This method provides access to the CPPMN.STARTDATE column of DB2 type TIMESTAMP NOT NULL.
 void setStatus(java.lang.String couponPromotionStatus)
          This method provides access to the CPPMN.STATUS column of DB2 type CHAR(1) NOT NULL.
 void setStoreId(java.lang.Integer storeId)
          This method provides access to the CPPMN.STOREENT_ID column of DB2 type INTEGER NOT NULL.
 void setTotalNumOffer(java.lang.Integer totalNumCouponsOffered)
          This method provides access to the CPPMN.TOTALNUMOFFER column of DB2 type INTEGER NOT NULL.
 void setValidityId(java.lang.Integer validityId)
          This method provides access to the CPPMN.CPPMNVAL_ID column of DB2 type INTEGER NULL.
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
__getCache, __getCache, __getKey, __setCache, __setCache, __setKey, commitCopyHelper, createAccessBeans, createAccessBeans, instantiateEJBByPrimaryKey, refreshCopyHelper, setEJBRef
 
Methods inherited from class com.ibm.ivj.ejb.runtime.AbstractAccessBean
defaultJNDIName, defaultNameServiceType, defaultNameServiceURL, getEJBRef, getGlobalHome, getHome, getInit_GlobalNameServiceTypeName, getInit_GlobalNameServiceURLName, getInit_JNDIName, getInit_NameServiceTypeName, getInit_NameServiceURLName, getInitContext, getInitContext, instantiateEJB, resetEJBRef, resetHomeCache, setInit_GlobalNameServiceTypeName, setInit_GlobalNameServiceURLName, setInit_JNDIName, setInit_NameServiceTypeName, setInit_NameServiceURLName
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CouponPromotionAccessBean

public CouponPromotionAccessBean()

Default constructor. Maps to findByPrimaryKey.


CouponPromotionAccessBean

public CouponPromotionAccessBean(javax.ejb.EJBObject newCouponPromotionEJB)
                          throws java.rmi.RemoteException

This method calls the ejbCreate method to create an entry in CPPMN table.

Parameters:
newCouponPromotionEJB - The coupon promotion EJB.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception

CouponPromotionAccessBean

public CouponPromotionAccessBean(java.lang.Integer newInitiativeId,
                                 java.lang.Integer newValidityId,
                                 java.lang.String newPurchaseCondType,
                                 java.lang.Integer newNumSeenAllowed,
                                 java.lang.String newPromoDispType,
                                 java.lang.Integer newNumUseAllowed,
                                 java.lang.Integer newTotalNumOffer,
                                 java.lang.String newCurrency,
                                 java.lang.String newPromoName,
                                 java.lang.String newPromoDesc,
                                 java.sql.Timestamp newStartTime,
                                 java.sql.Timestamp newEndTime,
                                 java.lang.Integer newStoreId)
                          throws javax.naming.NamingException,
                                 javax.ejb.CreateException,
                                 java.rmi.RemoteException,
                                 javax.ejb.FinderException

This method calls ejbCreate method to create an entry in CPPMN table.

Parameters:
newInitiativeId - The initiative Id.
newValidityId - The validity Id.
newPurchaseCondType - The purchase condition type (Order or Product)
newNumSeenAllowed - The number of times the coupons of this promotion be allowed to be seen.
newPromoDispType - The Promotion display type(Banner Ad or E-mail or Offerlist)
newNumUseAllowed - The number of times the coupons of this promition be allowed to be used.
newTotalNumOffer - The number of coupons to offer.
newCurrency - The currency.
newPromoName - The coupon promotion name.
newPromoDesc - The coupon promotion description.
newStartTime - The start time of the coupon promotion.
newEndTime - The end time of the coupon promotion.
newStoreId - The store Id.
Throws:
javax.naming.NamingException - The javax.naming.NamingException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
Method Detail

commitCopyHelper

public void commitCopyHelper()
                      throws java.rmi.RemoteException,
                             javax.ejb.CreateException,
                             javax.ejb.FinderException,
                             javax.naming.NamingException

Update(flush) data to the EJBObject (persistent storage).

Overrides:
commitCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByCouponPromotionId

public CouponPromotionAccessBean findByCouponPromotionId(java.lang.Integer couponPromotionId)
                                                  throws java.rmi.RemoteException,
                                                         javax.ejb.FinderException,
                                                         javax.naming.NamingException

This method executes the following SQL Script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.CPPMN_ID = ?

Parameters:
couponPromotionId - The coupon promotion Id.
Returns:
com.ibm.commerce.couponpromotion.objects.CouponPromotionAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByEndDateBefore

public java.util.Enumeration findByEndDateBefore(java.sql.Timestamp endDate)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.FinderException,
                                                 javax.naming.NamingException

This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.ENDDATE < ?.

Parameters:
endDate - The end date of the coupon promotion.
Returns:
The rows from CPPMN table.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByInitiativeId

public java.util.Enumeration findByInitiativeId(java.lang.Integer initiativeId)
                                         throws java.rmi.RemoteException,
                                                javax.ejb.FinderException,
                                                javax.naming.NamingException

This method executes the following SQL Script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.INITIATIVE_ID = ?

Parameters:
initiativeId - The initiative Id.
Returns:
The rows from CPPMN table.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByPromoNameStoreId

public CouponPromotionAccessBean findByPromoNameStoreId(java.lang.String couponPromotionName,
                                                        java.lang.Integer storeId)
                                                 throws java.rmi.RemoteException,
                                                        javax.ejb.FinderException,
                                                        javax.naming.NamingException

This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.CPPMNNAME = ? AND T1.STOREENT_ID = ?

Parameters:
couponPromotionName - The coupon promotion name.
storeId - The store ID.
Returns:
The row from CPPMN table.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

findByStoreIdStatus

public java.util.Enumeration findByStoreIdStatus(java.lang.Integer storeId,
                                                 java.lang.String status)
                                          throws java.rmi.RemoteException,
                                                 javax.ejb.FinderException,
                                                 javax.naming.NamingException

This method executes the following SQL script: SELECT T1.CPPMN_ID, T1.CREATIONTIME, T1.SETCCURR, T1.EARLYBIRDLIMIT, T1.ENDDATE, T1.FIELD1, T1.INITIATIVE_ID, T1.NUMOFFERED, T1.NUMSEENALLOWED, T1.NUMUSEALLOWED, T1.PROMODISPTYPE, T1.CPPMNDESC, T1.CPPMNNAME, T1.PURCHASECONDTYPE, T1.STARTDATE, T1.STATUS, T1.STOREENT_ID, T1.TOTALNUMOFFER, T1.CPPMNVAL_ID FROM CPPMN T1 WHERE T1.STOREENT_ID = ? AND T1.STATUS = ?

Parameters:
storeId - The store Id
status - The status
Returns:
The rows from CPPMN table.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

fulfills

public boolean fulfills(java.lang.Long userId,
                        java.lang.String relationship)
                 throws java.rmi.RemoteException,
                        java.lang.Exception,
                        javax.ejb.FinderException,
                        javax.naming.NamingException

This method is used for access control.

Parameters:
userId - The user.
relationship - The relationship.
Returns:
The return is true if user is authenticated to access this coupon promotion.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
java.lang.Exception - The java.lang.Exception exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCouponPromotionId

public java.lang.Integer getCouponPromotionId()
                                       throws java.rmi.RemoteException,
                                              javax.ejb.CreateException,
                                              javax.ejb.FinderException,
                                              javax.naming.NamingException

This method provides access to the CPPMN.CPPMN_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Coupon Promotion ID (primary key).

Specified by:
getCouponPromotionId in interface CouponPromotionAccessBeanData
Returns:
The coupon promotion Id.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCreationTime

public java.sql.Timestamp getCreationTime()
                                   throws java.rmi.RemoteException,
                                          javax.ejb.CreateException,
                                          javax.ejb.FinderException,
                                          javax.naming.NamingException

This method provides access to the CPPMN.CREATIONTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Date and time when this entry was made.

Specified by:
getCreationTime in interface CouponPromotionAccessBeanData
Returns:
The coupon promotion creation time.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getCurrency

public java.lang.String getCurrency()
                             throws java.rmi.RemoteException,
                                    javax.ejb.CreateException,
                                    javax.ejb.FinderException,
                                    javax.naming.NamingException

This method provides access to the CPPMN.SETCCURR column of DB2 type CHAR(3) NULL.

The following is a description of this column:

The default currency for this promotion. This is a currency code as per ISO 4217 standards.

Specified by:
getCurrency in interface CouponPromotionAccessBeanData
Returns:
The currency.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getEarlyBirdLimit

public java.lang.Integer getEarlyBirdLimit()
                                    throws java.rmi.RemoteException,
                                           javax.ejb.CreateException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

This method provides access to the CPPMN.EARLYBIRDLIMIT column of DB2 type INTEGER NULL.

The following is a description of this column:

Limit for early-bird coupons. If this attribute is NULL, it indicates that the promotion is not of early-bird type.

Specified by:
getEarlyBirdLimit in interface CouponPromotionAccessBeanData
Returns:
The total number of eraly bird coupons.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getEndDate

public java.sql.Timestamp getEndDate()
                              throws java.rmi.RemoteException,
                                     javax.ejb.CreateException,
                                     javax.ejb.FinderException,
                                     javax.naming.NamingException

This method provides access to the CPPMN.ENDDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The date after which this coupon promotion will not be effective.

Specified by:
getEndDate in interface CouponPromotionAccessBeanData
Returns:
The end date of the coupon promotion.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getField1

public java.lang.String getField1()
                           throws java.rmi.RemoteException,
                                  javax.ejb.CreateException,
                                  javax.ejb.FinderException,
                                  javax.naming.NamingException

This method provides access to the CPPMN.FIELD1 column of DB2 type VARCHAR(64) NULL.

The following is a description of this column:

Customizable.

Specified by:
getField1 in interface CouponPromotionAccessBeanData
Returns:
The customizable field.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getInitiativeId

public java.lang.Integer getInitiativeId()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

This method provides access to the CPPMN.INITIATIVE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Foreign Key to the initiative table, to which this promotion belong to.

Specified by:
getInitiativeId in interface CouponPromotionAccessBeanData
Returns:
The initiative Id.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getNumOffered

public java.lang.Integer getNumOffered()
                                throws java.rmi.RemoteException,
                                       javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException

This method provides access to the CPPMN.NUMOFFERED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of coupons already offered from this promotion.

Specified by:
getNumOffered in interface CouponPromotionAccessBeanData
Returns:
The total number number of coupons to offer.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getNumSeenAllowed

public java.lang.Integer getNumSeenAllowed()
                                    throws java.rmi.RemoteException,
                                           javax.ejb.CreateException,
                                           javax.ejb.FinderException,
                                           javax.naming.NamingException

This method provides access to the CPPMN.NUMSEENALLOWED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This field denotes the number of times this promotion should be offered to the user. Valid for only banner ads not for OfferLists.

Specified by:
getNumSeenAllowed in interface CouponPromotionAccessBeanData
Returns:
The number of times the user is allowed to see this coupon.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getNumUseAllowed

public java.lang.Integer getNumUseAllowed()
                                   throws java.rmi.RemoteException,
                                          javax.ejb.CreateException,
                                          javax.ejb.FinderException,
                                          javax.naming.NamingException

This method provides access to the CPPMN.NUMUSEALLOWED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of times this coupon can be redeemed.

Specified by:
getNumUseAllowed in interface CouponPromotionAccessBeanData
Returns:
The numer of times a coupon from this promotion be allowed to use.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getOwner

public java.lang.Long getOwner()
                        throws java.lang.Exception,
                               java.rmi.RemoteException,
                               javax.ejb.FinderException,
                               javax.naming.NamingException

This method is used for access control.

Returns:
The user Id.
Throws:
java.lang.Exception - The java.lang.Exception exception
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getPromoDispType

public java.lang.String getPromoDispType()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

This method provides access to the CPPMN.PROMODISPTYPE column of DB2 type CHAR(4) NOT NULL.

The following is a description of this column:

How is the promotion communicated with the media. That is, where is it shown. Possible values: B=Banner Ad, E=Email, and O=OfferList.

Specified by:
getPromoDispType in interface CouponPromotionAccessBeanData
Returns:
The coupon promotion display type(banner ad, e-mail or offerlist).
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getPromotionDescription

public java.lang.String getPromotionDescription()
                                         throws java.rmi.RemoteException,
                                                javax.ejb.CreateException,
                                                javax.ejb.FinderException,
                                                javax.naming.NamingException

This method provides access to the CPPMN.CPPMNDESC column of DB2 type CHAR(254) NULL.

The following is a description of this column:

Description of the coupon promotion (for merchant viewing).

Specified by:
getPromotionDescription in interface CouponPromotionAccessBeanData
Returns:
The coupon promotion description.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getPromotionName

public java.lang.String getPromotionName()
                                  throws java.rmi.RemoteException,
                                         javax.ejb.CreateException,
                                         javax.ejb.FinderException,
                                         javax.naming.NamingException

This method provides access to the CPPMN.CPPMNNAME column of DB2 type CHAR(64) NOT NULL.

The following is a description of this column:

Name of the coupon promotion.

Specified by:
getPromotionName in interface CouponPromotionAccessBeanData
Returns:
The coupon promotion name.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getPurchaseCondType

public java.lang.String getPurchaseCondType()
                                     throws java.rmi.RemoteException,
                                            javax.ejb.CreateException,
                                            javax.ejb.FinderException,
                                            javax.naming.NamingException

This method provides access to the CPPMN.PURCHASECONDTYPE column of DB2 type CHAR(4) NOT NULL.

The following is a description of this column:

This field specifies the promotion purchase condition type. Possible values: P=Product and O=Order.

Specified by:
getPurchaseCondType in interface CouponPromotionAccessBeanData
Returns:
The purchase condition type(order or product).
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getStartDate

public java.sql.Timestamp getStartDate()
                                throws java.rmi.RemoteException,
                                       javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException

This method provides access to the CPPMN.STARTDATE column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

The date before which this coupon promotion will not be effective.

Specified by:
getStartDate in interface CouponPromotionAccessBeanData
Returns:
The start date of the coupon promotion.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getStatus

public java.lang.String getStatus()
                           throws java.rmi.RemoteException,
                                  javax.ejb.CreateException,
                                  javax.ejb.FinderException,
                                  javax.naming.NamingException

This method provides access to the CPPMN.STATUS column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

Indicates the status of the coupon promotion. Valid values: A=active, D=deleted, or E=expired.

Specified by:
getStatus in interface CouponPromotionAccessBeanData
Returns:
The status of the coupon promotion.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getStoreId

public java.lang.Integer getStoreId()
                             throws java.rmi.RemoteException,
                                    javax.ejb.CreateException,
                                    javax.ejb.FinderException,
                                    javax.naming.NamingException

This method provides access to the CPPMN.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The ID of the store that owns this coupon promotion.

Specified by:
getStoreId in interface CouponPromotionAccessBeanData
Returns:
The store Id.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getTotalNumOffer

public java.lang.Integer getTotalNumOffer()
                                   throws java.rmi.RemoteException,
                                          javax.ejb.CreateException,
                                          javax.ejb.FinderException,
                                          javax.naming.NamingException

This method provides access to the CPPMN.TOTALNUMOFFER column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of coupons to be offered for this promotion. This indicates the accepted number of coupons by the customers.

Specified by:
getTotalNumOffer in interface CouponPromotionAccessBeanData
Returns:
The total number of coupons to offer.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

getValidityId

public java.lang.Integer getValidityId()
                                throws java.rmi.RemoteException,
                                       javax.ejb.CreateException,
                                       javax.ejb.FinderException,
                                       javax.naming.NamingException

This method provides access to the CPPMN.CPPMNVAL_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Foreign key to CPPMNVAL table.

Specified by:
getValidityId in interface CouponPromotionAccessBeanData
Returns:
The validity Id.
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

refreshCopyHelper

public void refreshCopyHelper()
                       throws java.rmi.RemoteException,
                              javax.ejb.CreateException,
                              javax.ejb.FinderException,
                              javax.naming.NamingException

Load data from the EJBObject.

Overrides:
refreshCopyHelper in class com.ibm.ivj.ejb.runtime.AbstractEntityAccessBean
Throws:
java.rmi.RemoteException - The java.rmi.RemoteException exception
javax.ejb.CreateException - The javax.ejb.CreateException exception
javax.ejb.FinderException - The javax.ejb.FinderException exception
javax.naming.NamingException - The javax.naming.NamingException exception

setCouponPromotionId

public void setCouponPromotionId(java.lang.Integer couponPromotionId)

This method provides access to the CPPMN.CPPMN_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Coupon Promotion ID (primary key).

Specified by:
setCouponPromotionId in interface CouponPromotionAccessBeanData
Parameters:
couponPromotionId - The coupon promotion Id.

setCreationTime

public void setCreationTime(java.sql.Timestamp creationTime)

This method provides access to the CPPMN.CREATIONTIME column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

Date and time when this entry was made.

Specified by:
setCreationTime in interface CouponPromotionAccessBeanData
Parameters:
creationTime - The creation time.

setCurrency

public void setCurrency(java.lang.String currency)

This method provides access to the CPPMN.SETCCURR column of DB2 type CHAR(3) NULL.

The following is a description of this column:

The default currency for this promotion. This is a currency code as per ISO 4217 standards.

Specified by:
setCurrency in interface CouponPromotionAccessBeanData
Parameters:
currency - The currency.

setEarlyBirdLimit

public void setEarlyBirdLimit(java.lang.Integer earlyBirdLimit)

This method provides access to the CPPMN.EARLYBIRDLIMIT column of DB2 type INTEGER NULL.

The following is a description of this column:

Limit for early-bird coupons. If this attribute is NULL, it indicates that the promotion is not of early-bird type.

Specified by:
setEarlyBirdLimit in interface CouponPromotionAccessBeanData
Parameters:
earlyBirdLimit - The limit of early-bird coupons.

setEndDate

public void setEndDate(java.sql.Timestamp endDate)

This method provides access to the CPPMN.ENDDATE column of DB2 type TIMESTAMP NULL.

The following is a description of this column:

The date after which this coupon promotion will not be effective.

Specified by:
setEndDate in interface CouponPromotionAccessBeanData
Parameters:
endDate - The end date of the coupon promotion.

setField1

public void setField1(java.lang.String field1)

This method provides access to the CPPMN.FIELD1 column of DB2 type VARCHAR(64) NULL.

The following is a description of this column:

Customizable.

Specified by:
setField1 in interface CouponPromotionAccessBeanData
Parameters:
field1 - The customizable field.

setInitiativeId

public void setInitiativeId(java.lang.Integer initiativeId)

This method provides access to the CPPMN.INITIATIVE_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Foreign Key to the initiative table, to which this promotion belong to.

Specified by:
setInitiativeId in interface CouponPromotionAccessBeanData
Parameters:
initiativeId - The initiative Id.

setInitKey_couponPromotionId

public void setInitKey_couponPromotionId(java.lang.Integer couponPromotionId)

Set the primary key for this object

Parameters:
couponPromotionId - The coupon promotion Id.

setNumOffered

public void setNumOffered(java.lang.Integer numOffered)

This method provides access to the CPPMN.NUMOFFERED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of coupons already offered from this promotion.

Specified by:
setNumOffered in interface CouponPromotionAccessBeanData
Parameters:
numOffered - The number of coupons already offered.

setNumSeenAllowed

public void setNumSeenAllowed(java.lang.Integer numTimesPromotionOfferedToUser)

This method provides access to the CPPMN.NUMSEENALLOWED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

This field denotes the number of times this promotion should be offered to the user. Valid for only banner ads not for OfferLists.

Specified by:
setNumSeenAllowed in interface CouponPromotionAccessBeanData
Parameters:
numTimesPromotionOfferedToUser - The number of times the coupon promotion should be offered to the user.

setNumUseAllowed

public void setNumUseAllowed(java.lang.Integer numUsesAllowed)

This method provides access to the CPPMN.NUMUSEALLOWED column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of times this coupon can be redeemed.

Specified by:
setNumUseAllowed in interface CouponPromotionAccessBeanData
Parameters:
numUsesAllowed - The number of times a coupon of this promotion be allowed to use.

setPromoDispType

public void setPromoDispType(java.lang.String promoDisplayType)

This method provides access to the CPPMN.PROMODISPTYPE column of DB2 type CHAR(4) NOT NULL.

The following is a description of this column:

How is the promotion communicated with the media. That is, where is it shown. Possible values: B=Banner Ad, E=Email, and O=OfferList.

Specified by:
setPromoDispType in interface CouponPromotionAccessBeanData
Parameters:
promoDisplayType - The promotion display media (Banner Ad, e-mail or offerlist)

setPromotionDescription

public void setPromotionDescription(java.lang.String promotionDescription)

This method provides access to the CPPMN.CPPMNDESC column of DB2 type CHAR(254) NULL.

The following is a description of this column:

Description of the coupon promotion (for merchant viewing).

Specified by:
setPromotionDescription in interface CouponPromotionAccessBeanData
Parameters:
promotionDescription - The coupon promotion description.

setPromotionName

public void setPromotionName(java.lang.String promotionName)

This method provides access to the CPPMN.CPPMNNAME column of DB2 type CHAR(64) NOT NULL.

The following is a description of this column:

Name of the coupon promotion.

Specified by:
setPromotionName in interface CouponPromotionAccessBeanData
Parameters:
promotionName - The coupon promotion name.

setPurchaseCondType

public void setPurchaseCondType(java.lang.String purchaseCondType)

This method provides access to the CPPMN.PURCHASECONDTYPE column of DB2 type CHAR(4) NOT NULL.

The following is a description of this column:

This field specifies the promotion purchase condition type. Possible values: P=Product and O=Order.

Specified by:
setPurchaseCondType in interface CouponPromotionAccessBeanData
Parameters:
purchaseCondType - The purchase condition type(product or order).

setStartDate

public void setStartDate(java.sql.Timestamp startDate)

This method provides access to the CPPMN.STARTDATE column of DB2 type TIMESTAMP NOT NULL.

The following is a description of this column:

The date before which this coupon promotion will not be effective.

Specified by:
setStartDate in interface CouponPromotionAccessBeanData
Parameters:
startDate - The start date of the coupon promotion.

setStatus

public void setStatus(java.lang.String couponPromotionStatus)

This method provides access to the CPPMN.STATUS column of DB2 type CHAR(1) NOT NULL.

The following is a description of this column:

Indicates the status of the coupon promotion. Valid values: A=active, D=deleted, or E=expired.

Specified by:
setStatus in interface CouponPromotionAccessBeanData
Parameters:
couponPromotionStatus - The status of the coupon promotion.

setStoreId

public void setStoreId(java.lang.Integer storeId)

This method provides access to the CPPMN.STOREENT_ID column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

The ID of the store that owns this coupon promotion.

Specified by:
setStoreId in interface CouponPromotionAccessBeanData
Parameters:
storeId - The store Id.

setTotalNumOffer

public void setTotalNumOffer(java.lang.Integer totalNumCouponsOffered)

This method provides access to the CPPMN.TOTALNUMOFFER column of DB2 type INTEGER NOT NULL.

The following is a description of this column:

Number of coupons to be offered for this promotion. This indicates the accepted number of coupons by the customers.

Specified by:
setTotalNumOffer in interface CouponPromotionAccessBeanData
Parameters:
totalNumCouponsOffered - The total number of coupons to offer.

setValidityId

public void setValidityId(java.lang.Integer validityId)

This method provides access to the CPPMN.CPPMNVAL_ID column of DB2 type INTEGER NULL.

The following is a description of this column:

Foreign key to CPPMNVAL table.

Specified by:
setValidityId in interface CouponPromotionAccessBeanData
Parameters:
validityId - The validity Id.