com.ibm.commerce.couponpromotion.objects
Interface CouponPromotionAccessBeanData

All Known Implementing Classes:
CouponPromotionAccessBean

public interface CouponPromotionAccessBeanData


Method Summary
 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.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 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 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 status)
          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.
 

Method Detail

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).

Returns:
The coupon promotion Id.

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.

Returns:
The coupon promotion creation time.

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.

Returns:
The currency.

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.

Returns:
The number of early bird coupons.

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.

Returns:
The end date of the coupon promotion.

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.

Returns:
The customizable field.

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.

Returns:
The initiative Id.

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.

Returns:
The total number of coupons to offer.

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.

Returns:
The number of times the coupon promotion should be offered to the user.

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.

Returns:
The number of times a coupon can be used.

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.

Returns:
The coupon promotion display type.

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).

Returns:
The coupon promotion description.

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.

Returns:
The coupon promotion name.

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.

Returns:
The purchase condition type(product or order).

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.

Returns:
The start date of the coupon promotion.

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.

Returns:
The status of the coupon promotion.

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.

Returns:
The store Id.

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.

Returns:
The total number of coupons to offer.

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.

Returns:
The validity Id.

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).

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.

Parameters:
creationTime - The creation time of the coupon promotion.

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.

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.

Parameters:
earlyBirdLimit - The number 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.

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.

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.

Parameters:
initiativeId - The initiative 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.

Parameters:
numOffered - The total number of coupons to offer.

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.

Parameters:
numTimesPromotionOfferedToUser - The number of times the coupon promotion is seen by 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.

Parameters:
numUsesAllowed - The number of times the coupo can be used.

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.

Parameters:
promoDisplayType - The coupon promotion display type (banner ad, e-mail, 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).

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.

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.

Parameters:
purchaseCondType - The purchase condition type(product, 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.

Parameters:
startDate - The start date of the coupon promotion.

setStatus

public void setStatus(java.lang.String status)

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.

Parameters:
status - 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.

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.

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.

Parameters:
validityId - The validity Id.