com.ibm.commerce.catalogmanagement.commands
Interface OfferDeleteCmd

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

public interface OfferDeleteCmd
extends ControllerCommand

Command Name: OfferDelete Command Type: URL and Controller Command Description: 1. If OfferId is supplied, and 1.1. If Description Language Id is supplied, then delete the Offer Description with the specified OfferId and Language ID. 1.2. If Currency is supplied, then delete the Offer Price with the specified OfferId and Currency, and if no more OfferPrice exists for that OfferId, the Offer will be deleted or marked for deletion. There is a force option available for this command, and by default, force=0, and it is set to mark for deletion. Also calls ListPriceDelete with the Currency and CatEntryId found in the Offer. 1.3. If Currency is generic, then delete or mark for delete the Offer, depending on what is set on the force option, and OfferPrice with the sepcified OfferId. Also calls ListPriceDelete with the CatEntryId found in the Offer. 1.4 At least one of Currency or Language ID is required, if both are missing, the an exception will be thrown. 2. If CatEnryId is supplied, and 2.1. If Desctription Language Id is supplied, then delete all Offer Description with the specified Language Id for that CatEntryId. 2.2. If Currency is supplied, then for each Offer with the specified CatEntryId, the OfferPrice for that Currenct is deleted. Also calls ListPriceDelete for the specied CatEntryId and Currency. 2.3. If Currency is generic, then all Offer will be deleted or marked for deletion, depending on the force option value. Also, all the OfferDescription, OfferPrice with the specified CatEntryId is deleted. Also calls ListPriceDelete witht the CatEntryId. 2.4 At least one of Currency or Language Id is required, if both are missing, the an exception will be thrown. Parameters: 1. OfferId, and 1.1. DescLangId 1.2. Currency 1.3. Currency=* 2. CatEntryId, and 2.1. DescLangId 2.2. Currency 2.3. Currency=* Tables: 1. 1.1. OfferDescription 1.2. Offer, OfferPrice, also see ListPriceDelete 1.3. Offer, OfferPrice, also see ListPriceDelete 2. 2.1. OfferDescription 2.2. Offer, OfferPrice, also see ListPriceDelete 2.3. Offer, OfferPrice, also see ListPriceDelete Task Commands: DeleteOfferCmd Other Controller Commands: ListpriceDeleteCmd Mandatory Parameters: offerId, or catentryId Additional Parameters: Optional Parameters: precedence, qtyunitId, descLangId, currency, force, URL


Field Summary
static java.lang.String CLASSNAME
           
static java.lang.String COPYRIGHT
           
 
Fields inherited from interface com.ibm.commerce.command.ECCommand
defaultCommandClassName
 
Method Summary
 java.lang.Long getCatentryId()
          Get the catalog entry Id
 java.lang.String getCurrency()
          Get the currency
 void setCatentryId(java.lang.Long anCatentryId)
          Set the catalog entry Id
 void setCurrency(java.lang.String astrCurrency)
          Set the currency
 void setDescLanguage(java.lang.Integer anDescLanguage)
          Set the language Id for the offer description
 void setForce(java.lang.Integer anForce)
          Set the force delete option for the offer 0 = offer will be marked for delete 1 = offer will be force deleted
 void setIdentifier(java.lang.Long anIdentifier)
          Set the offer identifier
 void setOfferId(java.lang.Long anOfferId)
          Set the offer Id
 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 setQtyunitId(java.lang.String astrQtyunitId)
          Set the quantity unit Id.
 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

COPYRIGHT

public static final java.lang.String COPYRIGHT
Method Detail

getCatentryId

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

getCurrency

public java.lang.String getCurrency()
Get the currency
Returns:
java.lang.String

setCatentryId

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

setCurrency

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

setDescLanguage

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

setForce

public void setForce(java.lang.Integer anForce)
Set the force delete option for the offer 0 = offer will be marked for delete 1 = offer will be force deleted
Parameters:
anForce - java.lang.Integer

setIdentifier

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

setOfferId

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

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

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

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