com.ibm.commerce.catalogmanagement.commands
Interface OfferAddCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable
All Known Implementing Classes:
OfferAddCmdImpl

public interface OfferAddCmd
extends ControllerCommand

Command Name: OfferAdd Command Type: URL and Controller Command Description: 1. Adds a new Offer, 2. Adds a new Offer Description, 3. Adds a new Offer Price. 4. Calls List PriceAdd command Parameters: 1. All fields in the Offer. 2. All fields in the OfferDesc. 3. All fields in the OfferPrice 4. See ListPriceAdd command Tables: 1. Offer 2. OfferDescription 3. OfferPrice 4. See ListPriceAdd command Task Commands: AddOfferCmd Other Controller Commands: ListpriceAddCmd Mandatory Parameters: (catentryId + identifier, or OfferID if offer already exists), Additional Parameters: Optional Parameters: field1, field2, flags, maxQuantity, minQuantity, precedence, published, qtyunitId, desc, descLangId, compareprice, currency + price, URL


Field Summary
static java.lang.String CLASSNAME
          The name of this interface is "com.ibm.commerce.catalogmanagement.commands.OfferAddCmd".
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.Long getCatentryId()
          Get the catalog entry Id
 java.lang.Long getOfferId()
          Get the offer Id
 void setCatentryId(java.lang.Long anCatentryId)
          Set the catalog entry Id
 void setCompareprice(java.math.BigDecimal abdCompareprice)
          Set the comparative price
 void setCurrency(java.lang.String astrCurrency)
          Set the currency of the price
 void setDescLanguage(java.lang.Integer anDescLanguage)
          Set the language Id used for the offer description
 void setDescription(java.lang.String astrDescription)
          Set the description of the offer
 void setEnddate(java.sql.Timestamp atmEnddate)
          Set the end date of the offer
 void setField1(java.lang.String astrField1)
          Set field 1
 void setField2(java.lang.String astrField2)
          Set field 2
 void setFlags(java.lang.Integer anFlags)
          Set offer flags 1 = shipto address required (if 1, OrderPrepare will return an error if an OrderItem references this offer but does not have a shipping address)
 void setIdentifier(java.lang.Long anIdentifier)
          Set the offer identifier
 void setLastupdate(java.sql.Timestamp atmLastupdate)
          Set the last update time of the offer
 void setMaximumQuantity(java.lang.Double adMaximumQuantity)
          Set the maximum quantity allowed for the offer
 void setMinimumQuantity(java.lang.Double adMinimumQuantity)
          Set the minimum quantity required for the offer
 void setOfferId(java.lang.Long anOfferId)
          Set the offer Id
 void setOID(java.lang.String astrOID)
          Set the object identififer
 void setPrecedence(java.lang.Double adPrecedence)
          Set the precedence of the offer When more than one offer is effective at a particular time, the one with the highest precedence is used.
 void setPrice(java.math.BigDecimal abdPrice)
          Set the price
 void setPublished(java.lang.Integer anPublished)
          Set the published flag of the offer 0 = offer is not published (temporarily disabled).
 void setQtyunitId(java.lang.String astrQtyunitId)
          Set the quantity unit Id.
 void setStartdate(java.sql.Timestamp atmStartdate)
          Set the start date of the offer
 void setTradeposcnId(java.lang.Long anTradeposcnId)
          Set trading positioning container Id for the offer
 void setURL(java.lang.String astrURL)
          Set the redirect URL
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this interface is "com.ibm.commerce.catalogmanagement.commands.OfferAddCmd".

COPYRIGHT

public static final java.lang.String COPYRIGHT
The internal copyright field.
Method Detail

getCatentryId

public java.lang.Long getCatentryId()
Get the catalog entry Id
Returns:
java,lang.Long

getOfferId

public java.lang.Long getOfferId()
Get the offer Id
Returns:
java.lang.Long

setCatentryId

public void setCatentryId(java.lang.Long anCatentryId)
Set the catalog entry Id
Parameters:
anCatentryId - java.lang.Long

setCompareprice

public void setCompareprice(java.math.BigDecimal abdCompareprice)
Set the comparative price
Parameters:
abdCompareprice - java.math.BigDecimal

setCurrency

public void setCurrency(java.lang.String astrCurrency)
Set the currency of the price
Parameters:
astrCurrency - java.lang.String

setDescLanguage

public void setDescLanguage(java.lang.Integer anDescLanguage)
Set the language Id used for the offer description
Parameters:
anDescLanguage - java.lang.Integer

setDescription

public void setDescription(java.lang.String astrDescription)
Set the description of the offer
Parameters:
astrDescription - java.lang.String

setEnddate

public void setEnddate(java.sql.Timestamp atmEnddate)
Set the end date of the offer
Parameters:
atmEnddate - java.sql.Timestamp

setField1

public void setField1(java.lang.String astrField1)
Set field 1
Parameters:
astrField1 - java.lang.String

setField2

public void setField2(java.lang.String astrField2)
Set field 2
Parameters:
astrField2 - java.lang.String

setFlags

public void setFlags(java.lang.Integer anFlags)
Set offer flags 1 = shipto address required (if 1, OrderPrepare will return an error if an OrderItem references this offer but does not have a shipping address)
Parameters:
anFlags - java.lang.Integer

setIdentifier

public void setIdentifier(java.lang.Long anIdentifier)
Set the offer identifier
Parameters:
anIdentifier - java.lang.Long

setLastupdate

public void setLastupdate(java.sql.Timestamp atmLastupdate)
Set the last update time of the offer
Parameters:
atmLastupdate - java.sql.Timestamp

setMaximumQuantity

public void setMaximumQuantity(java.lang.Double adMaximumQuantity)
Set the maximum quantity allowed for the offer
Parameters:
adMaximumQuantity - java.lang.Double

setMinimumQuantity

public void setMinimumQuantity(java.lang.Double adMinimumQuantity)
Set the minimum quantity required for the offer
Parameters:
adMinimumQuantity - java.lang.Double

setOfferId

public void setOfferId(java.lang.Long anOfferId)
Set the offer Id
Parameters:
anOfferId - java.lang.Long

setOID

public void setOID(java.lang.String astrOID)
Set the object identififer
Parameters:
astrOID - java.lang.String

setPrecedence

public void setPrecedence(java.lang.Double adPrecedence)
Set the precedence of the offer When more than one offer is effective at a particular time, the one with the highest precedence is used.
Parameters:
adPrecedence - java.lang.Double

setPrice

public void setPrice(java.math.BigDecimal abdPrice)
Set the price
Parameters:
abdPrice - java.math.BigDecimal

setPublished

public void setPublished(java.lang.Integer anPublished)
Set the published flag of the offer 0 = offer is not published (temporarily disabled). 1 = offer is published. 2 = offer is marked for deletion (and not published).
Parameters:
anPublished - java.lang.Integer

setQtyunitId

public void setQtyunitId(java.lang.String astrQtyunitId)
Set the quantity unit Id. This is the unit of measure for minimum quantity and maximum quantity
Parameters:
astrQtyunitId - java.lang.String

setStartdate

public void setStartdate(java.sql.Timestamp atmStartdate)
Set the start date of the offer
Parameters:
atmStartdate - java.sql.Timestamp

setTradeposcnId

public void setTradeposcnId(java.lang.Long anTradeposcnId)
Set trading positioning container Id for the offer
Parameters:
anTradeposcnId - java.lang.Long

setURL

public void setURL(java.lang.String astrURL)
Set the redirect URL
Parameters:
astrURL - java.lang.String