com.ibm.commerce.price.commands

Interface FloorPriceLookupCmd

All Superinterfaces:

com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.commerce.command.ECCommand, com.ibm.commerce.command.TaskCommand

All Known Implementing Classes:

FloorPriceLookupCmdImpl

public interface FloorPriceLookupCmd
extends com.ibm.commerce.command.TaskCommand

Interface for the FloorPriceLookupCmd Task Command to lookup the floor price for a catalog entry. The floor price is the nominal cost of the catalog entry with optional percentage adjustment. The quantity is assumed to be 1.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The default name of this command.
static java.lang.String	NAME The name of this command.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCurrency() Returns the currency.
MonetaryAmount	getFloorPrice() Gets the floor price for the given catalog entry with the requested currency.
void	setCatEntryId(java.lang.Long catEntryId) Sets the catalog entry ID whose floor price is to be retrieved.
void	setConfigurationID(java.lang.String aConfigID) Sets the configuration ID, if this catalog entry is a DynamicKit.
void	setCurrency(java.lang.String currency) Set the currency to be used for finding the floor price.
void	setCustomPartnumber(java.lang.String customPartnumber) Sets the custom partnumber whose floor price is to be retrieved.
void	setErrorMode(boolean aErrorMode) Sets the flag to indicate if exception will be thrown when the price cannot be found for the input catentry (Optional).
void	setQuantity(QuantityAmount aQuantityAmount) Sets the quantity amount of the input catalog entry that is to be priced (Optional).
void	setStoreId(java.lang.Integer storeId) Set the store ID
void	setTSRId(java.lang.Long tsrId) Set the TSR ID.

Methods inherited from class java.lang.Object

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

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

execute

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

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

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

IBM copyright notice field.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The default name of this command.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this command.

See Also:

Constant Field Values

Method Detail

getCurrency

java.lang.String getCurrency()

Returns the currency.

Returns:

String

getFloorPrice

MonetaryAmount getFloorPrice()

Gets the floor price for the given catalog entry with the requested currency.

Returns:

A MonetaryAmount for the catalog entry.

setCatEntryId

void setCatEntryId(java.lang.Long catEntryId)

Sets the catalog entry ID whose floor price is to be retrieved. Mandatory if custom partnumber is not set

Parameters:

catEntryId - A reference number of catalog entry.

setConfigurationID

void setConfigurationID(java.lang.String aConfigID)

Sets the configuration ID, if this catalog entry is a DynamicKit. (Optional)

Parameters:

aConfigID - A String of pre-configuration ID for a DynamicKit

setCurrency

void setCurrency(java.lang.String currency)

Set the currency to be used for finding the floor price. If the currency is not specified then the "negotiated" currency is used for the store Id and TSR's preferred currency. (The negotiated currency is the currency returned from the getCurrency() method of the currency manager). Optional

Parameters:

aCurrency - the currency.

setCustomPartnumber

void setCustomPartnumber(java.lang.String customPartnumber)

Sets the custom partnumber whose floor price is to be retrieved. Mandatory if catentry is not set

Parameters:

customPartnumber - The custom partnumber.

setErrorMode

void setErrorMode(boolean aErrorMode)

Sets the flag to indicate if exception will be thrown when the price cannot be found for the input catentry (Optional).

Parameters:

aErrorMode - The indicator to decide if an exception will be thrown when the price cannot be found. A true value (default) means throw exception. A false value means do not throw exception and returns a null value price

setQuantity

void setQuantity(QuantityAmount aQuantityAmount)

Sets the quantity amount of the input catalog entry that is to be priced (Optional).

Parameters:

aQuantityAmount - The quantity amount of the catalog entry. The quantity amount helps determine which offers are valid. If the quantity amount is not specified; then the nominal quantity (rounded up to the nearest multiple as specified in the quantityMultiple attribute) of the Catalog entry is assumed to be the requested quantity.

setStoreId

void setStoreId(java.lang.Integer storeId)

Set the store ID

Parameters:

storeId - A store ID, if not provided, get from the CommandContext.

setTSRId

void setTSRId(java.lang.Long tsrId)

Set the TSR ID. If not provided, uses the user ID from CommandContext as TSR ID.

Parameters:

tsrId - Long A TSR ID