com.ibm.commerce.catalogmanagement.commands

Class OfferDeleteCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.ControllerCommandImpl

com.ibm.commerce.catalogmanagement.commands.OfferDeleteCmdImpl

All Implemented Interfaces:

OfferDeleteCmd, AccCommand, ControllerCommand, ECCommand, ECTargetableCommand, Protectable, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

public class OfferDeleteCmdImpl
extends ControllerCommandImpl
implements OfferDeleteCmd

The OfferDeleteCmd is a URL and controller command that:

• If the offer ID is supplied, and
  • If the description language ID is supplied, then deletes the offer description with the specified offer ID and language ID.
  • If the currency is supplied, then deletes 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 deletes 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 description 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.


See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASSNAME The name of this interface is "com.ibm.commerce.catalogmanagement.commands.OfferDeleteCmdImpl".
static java.lang.String	COPYRIGHT The internal copyright field.
java.lang.Boolean	GENERIC_CURRENCY

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.command.ECCommand

defaultCommandClassName

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
OfferDeleteCmdImpl()

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCatentryId() Get the catalog entry Id
java.lang.String	getCurrency() Get the currency
java.lang.Integer	getDescLanguage() Get the description language Id
java.lang.Integer	getForce() Get the force delete option 0 = offer will be marked for deletion 1 = offer will be force deleted
java.lang.Long	getIdentifier() Get the offer identifier
java.lang.Long	getOfferId() Get the offer Id
java.lang.Long	getTradeposcnId() Get trading position container Id
java.lang.String	getURL() Get the redirect URL
void	performExecute() The main program for OfferDelete command
void	reset() This method reset all the variables used in OfferDelete command
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 language Id of the offer description
void	setForce(java.lang.Integer anForce) Set the force delete option of 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	setRequestProperties(TypedProperty reqParms) This method obtain the input parameters for OfferDelete command
void	setTradeposcnId(java.lang.Long anTradeposcnId) Set trading positioning container Id for the offer
void	setURL(java.lang.String astrURL) Set a redirect URL param astrURL java.lang.String
void	validateParameters() This method validates the parameters for OfferDelete command

Methods inherited from class com.ibm.commerce.command.ControllerCommandImpl

checkPermission, fulfills, getForUserId, getGeneric, getOwner, getRequestProperties, getResolvedRequestProperties, getResourceOwners, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setForUserId, setGeneric, setOwner, setResponseProperties, setRetriable, setViewInputProperties

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.command.ControllerCommand

checkPermission, execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRetriable, setViewInputProperties

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.AccCommand

accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute

Methods inherited from interface com.ibm.commerce.security.Protectable

fulfills, getOwner

Field Detail

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.OfferDeleteCmdImpl".

See Also:

Constant Field Values

GENERIC_CURRENCY

public java.lang.Boolean GENERIC_CURRENCY

Constructor Detail

OfferDeleteCmdImpl

public OfferDeleteCmdImpl()

Method Detail

getCatentryId

public java.lang.Long getCatentryId()

Get the catalog entry Id

Specified by:

getCatentryId in interface OfferDeleteCmd

Returns:

java.lang.Long

getIdentifier

public java.lang.Long getIdentifier()

Get the offer identifier

Returns:

java.lang.Long

getCurrency

public java.lang.String getCurrency()

Get the currency

Specified by:

getCurrency in interface OfferDeleteCmd

Returns:

java.lang.String

getDescLanguage

public java.lang.Integer getDescLanguage()

Get the description language Id

Returns:

java.lang.Integer

getOfferId

public java.lang.Long getOfferId()

Get the offer Id

Returns:

java.lang.Long

getTradeposcnId

public java.lang.Long getTradeposcnId()

Get trading position container Id

Returns:

java.lang.Long

getForce

public java.lang.Integer getForce()

Get the force delete option 0 = offer will be marked for deletion 1 = offer will be force deleted

Returns:

java.lang.Integer

getURL

public java.lang.String getURL()

Get the redirect URL

Returns:

java.lang.String

performExecute

public void performExecute()
                    throws ECException

The main program for OfferDelete command

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException

reset

public void reset()

This method reset all the variables used in OfferDelete command

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setCatentryId

public void setCatentryId(java.lang.Long anCatentryId)

Set the catalog entry Id

Specified by:

setCatentryId in interface OfferDeleteCmd

Parameters:

anCatentryId - java.lang.Long

setCurrency

public void setCurrency(java.lang.String astrCurrency)

Set the currency

Specified by:

setCurrency in interface OfferDeleteCmd

Parameters:

astrCurrency - java.lang.String

setDescLanguage

public void setDescLanguage(java.lang.Integer anDescLanguage)

Set language Id of the offer description

Specified by:

setDescLanguage in interface OfferDeleteCmd

Parameters:

anDescLanguage - java.lang.Integer

setIdentifier

public void setIdentifier(java.lang.Long anIdentifier)

Set the offer identifier

Specified by:

setIdentifier in interface OfferDeleteCmd

Parameters:

anIdentifier - java.lang.Long

setOfferId

public void setOfferId(java.lang.Long anOfferId)

Set the offer Id

Specified by:

setOfferId in interface OfferDeleteCmd

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.

Specified by:

setPrecedence in interface OfferDeleteCmd

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

Specified by:

setQtyunitId in interface OfferDeleteCmd

Parameters:

astrQtyunitId - java.lang.String

setForce

public void setForce(java.lang.Integer anForce)

Set the force delete option of the offer 0 = offer will be marked for delete 1 = offer will be force deleted

Specified by:

setForce in interface OfferDeleteCmd

Parameters:

anForce - java.lang.Integer

setRequestProperties

public void setRequestProperties(TypedProperty reqParms)
                          throws ECApplicationException

This method obtain the input parameters for OfferDelete command

Specified by:

setRequestProperties in interface ControllerCommand

Overrides:

setRequestProperties in class ControllerCommandImpl

Parameters:

reqParms - This is an object that represents the request properties.

Throws:

ECApplicationException

setTradeposcnId

public void setTradeposcnId(java.lang.Long anTradeposcnId)

Set trading positioning container Id for the offer

Specified by:

setTradeposcnId in interface OfferDeleteCmd

Parameters:

anTradeposcnId - java.lang.Long

setURL

public void setURL(java.lang.String astrURL)

Set a redirect URL param astrURL java.lang.String

Specified by:

setURL in interface OfferDeleteCmd

Parameters:

astrURL - the redirect URL

validateParameters

public void validateParameters()
                        throws ECException

This method validates the parameters for OfferDelete command

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException