com.ibm.commerce.catalogmanagement.commands
Interface OfferDeleteCmd
- All Superinterfaces:
- AccCommand, ControllerCommand, ECCommand, Protectable
- All Known Implementing Classes:
- OfferDeleteCmdImpl
- public interface OfferDeleteCmd
- extends ControllerCommand
The OfferDeleteCmd is a URL and controller command that:
- If the offer ID is supplied, and
- If the description language ID is supplied, then delete the offer description with the specified offer ID and language ID.
- If the currency is supplied, then delete the offer price with the specified offer ID and currency, and if no more offer price exists for that offer ID, 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 ListPriceDeleteCmd with the currency and catalog entry ID found in the offer.
- If the currency is generic, then delete or mark for delete the offer, depending on what is set on the force option, and offer price with the specified offer ID. Also calls ListPriceDeleteCmd with the catalog entry ID found in the offer.
- At least one of currency or language ID is required, if both are missing, then an exception will be thrown.
- If the catalog entry ID is supplied, and
- If the desctription language ID is supplied, then deletes all offer description with the specified language ID for that catalog entry ID.
- If the currency is supplied, then for each offer with the specified catalog entry ID, the offer price for that currency is deleted. Also calls ListPriceDeleteCmd for the specied catalog entry ID and currency.
- If the currency supplied is generic, then all offers will be deleted or marked for deletion, depending on the force option value. Also, all the offer description, offer price with the specified catalog entry ID is deleted. Also calls ListPriceDeleteCmd with the catalog entry ID.
- At least one of currency or language ID is required, if both are missing, then an exception will be thrown.
Parameters:
- Offer ID, and
- Description Language ID
- Currency
- Currency=*
- Catalog Entry ID, and
- Description Language ID
- Currency
- Currency=*
Access Beans:
-
- OfferDescriptionAccessBean
- OfferAccessBean, OfferPriceAccessBean, ListPriceAccessBean
- OfferAccessBean, OfferPriceAccessBean, ListPriceAccessBean
-
- OfferDescriptionAccessBean
- OfferAccessBean, OfferPriceAccessBean, ListPriceAccessBean
- OfferAccessBean, OfferPriceAccessBean, ListPriceAccessBean
Task Commands: DeleteOfferCmd
Other Controller Commands: ListpriceDeleteCmd
Mandatory Parameters: offerId, or catentryId.
Additional Parameters: None.
Optional Parameters: precedence, qtyunitId, descLangId, currency, force, URL.
Field Summary |
static java.lang.String |
CLASSNAME
The name of this interface is "com.ibm.commerce.catalogmanagement.commands.OfferDeleteCmd". |
static java.lang.String |
COPYRIGHT
The internal copyright field. |
Method Summary |
java.lang.Long |
getCatentryId()
Gets the catalog entry ID. |
java.lang.String |
getCurrency()
Gets the currency for the offer price. |
void |
setCatentryId(java.lang.Long anCatentryId)
Sets the catalog entry ID in the offer. |
void |
setCurrency(java.lang.String astrCurrency)
Sets the currency used for the offer price. |
void |
setDescLanguage(java.lang.Integer anDescLanguage)
Sets the language ID used for the offer description. |
void |
setForce(java.lang.Integer anForce)
Sets the force delete option for the offer: 0 = offer will be marked for delete. |
void |
setIdentifier(java.lang.Long anIdentifier)
Sets the offer identifier. |
void |
setOfferId(java.lang.Long anOfferId)
Sets the offer ID. |
void |
setPrecedence(java.lang.Double adPrecedence)
Sets the precedence of the offer. |
void |
setQtyunitId(java.lang.String astrQtyunitId)
Sets the quantity unit ID. |
void |
setTradeposcnId(java.lang.Long anTradeposcnId)
Sets the trading position container ID for the offer. |
void |
setURL(java.lang.String astrURL)
Sets the redirect URL. |
Methods inherited from interface com.ibm.commerce.command.ControllerCommand |
checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties |
Methods inherited from interface com.ibm.commerce.command.ECCommand |
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters |
COPYRIGHT
public static final java.lang.String COPYRIGHT
- The internal copyright field.
- See Also:
- Constant Field Values
CLASSNAME
public static final java.lang.String CLASSNAME
- The name of this interface is "com.ibm.commerce.catalogmanagement.commands.OfferDeleteCmd".
- See Also:
- Constant Field Values
getCatentryId
public java.lang.Long getCatentryId()
- Gets the catalog entry ID.
-
- Returns:
- the catalog entry ID
getCurrency
public java.lang.String getCurrency()
- Gets the currency for the offer price.
-
- Returns:
- the currency
setCatentryId
public void setCatentryId(java.lang.Long anCatentryId)
- Sets the catalog entry ID in the offer.
-
- Parameters:
- anCatentryId - the catalog entry ID
setIdentifier
public void setIdentifier(java.lang.Long anIdentifier)
- Sets the offer identifier.
-
- Parameters:
- anIdentifier - the identifier of the offer
setPrecedence
public void setPrecedence(java.lang.Double adPrecedence)
- Sets 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 - the precedence of the offer
setQtyunitId
public void setQtyunitId(java.lang.String astrQtyunitId)
- Sets the quantity unit ID. This is the unit of measure for minimum quantity and maximum quantity. It is not used in the command.
-
- Parameters:
- astrQtyunitId - quantity unit ID
setTradeposcnId
public void setTradeposcnId(java.lang.Long anTradeposcnId)
- Sets the trading position container ID for the offer. It is not used in the command.
-
- Parameters:
- anTradeposcnId - the trading position container ID
setCurrency
public void setCurrency(java.lang.String astrCurrency)
- Sets the currency used for the offer price.
-
- Parameters:
- astrCurrency - the currency of the offer price
setDescLanguage
public void setDescLanguage(java.lang.Integer anDescLanguage)
- Sets the language ID used for the offer description.
-
- Parameters:
- anDescLanguage - the language ID
setOfferId
public void setOfferId(java.lang.Long anOfferId)
- Sets the offer ID.
-
- Parameters:
- anOfferId - the offer ID
setForce
public void setForce(java.lang.Integer anForce)
- Sets the force delete option for the offer:
- 0 = offer will be marked for delete.
- 1 = offer will be force deleted.
-
- Parameters:
- anForce - the force delete option for the offer
setURL
public void setURL(java.lang.String astrURL)
- Sets the redirect URL.
-
- Parameters:
- astrURL - the redirect URL
Feedback
(C) Copyright IBM Corporation 1996, 2005. All Rights Reserved.