com.ibm.commerce.negotiation.commands
Interface AuctionTaskBaseCmd

All Superinterfaces:
TaskCommand
All Known Subinterfaces:
CreateAuctionTaskCmd, ModifyAuctionTaskCmd
All Known Implementing Classes:
AuctionTaskBaseCmdImpl, CreateAuctionTaskCmdImpl, ModifyAuctionTaskCmdImpl

public interface AuctionTaskBaseCmd
extends TaskCommand

Auction task base command interface.


Field Summary
static java.sql.Timestamp AUCTION_BASE_TIMESTAMP
          The timestamp for the auction.
static java.lang.String COPYRIGHT
          Copyright statement.
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
          The full class name for this interface file.
 
Method Summary
 com.ibm.commerce.negotiation.objects.AuctionAccessBean getAuction()
          Returns the access bean representing the auction.
 void setBidRuleId(java.lang.Long br_id)
          Stores the identifier of the bid control rule used by the auction.
 void setCloseType(int aType)
          Stores an integer representing the auction close type.
 void setCurrentAskPrice(java.math.BigDecimal aPrice)
          Stores the current asking price for the item on a Dutch auction.
 void setDeposit(java.math.BigDecimal amount)
          Stores the value of the deposit that should accompany each bid for the auction.
 void setDurationDays(java.lang.Integer param)
          Stores the number of days between successive bids for which the auction would stay active.
 void setDurationTime(java.lang.Integer hours, java.lang.Integer minutes)
          Hours and minute for the duration field on auction closing rule.
 void setDurationTimestamp(java.sql.Timestamp dur)
          Stores the duration timestamp.
 void setEndTime(java.sql.Timestamp end)
          Stores the end date and time for the auction.
 void setFulfillmentCenterId(java.lang.Integer newFulfillmentCenterId)
          Stores the identifier for the fulfillment center.
 void setLongDescription(java.lang.Integer langid, java.lang.String ld)
          Stores the long description for the auction for the specified language.
 void setPricingRuleType(java.lang.String s)
          Stores the pricing rule for the auction.
 void setProductDisplayPage(java.lang.String s)
          Stores the path and name of the product display page.
 void setQuantity(java.lang.Double quant)
          Stores the quantity of the item on auction.
 void setReservationId(java.lang.Long v)
          Stores the identifier for the reservation.
 void setReservePrice(java.math.BigDecimal aPrice)
          Stores the minimum price for which the item will be sold.
 void setRuleDisplayPage(java.lang.String s)
          Stores the path and name of the web page that displays the auction rules.
 void setShortDescription(java.lang.Integer langid, java.lang.String s)
          Stores the short description for the specified language.
 void setStartPrice(java.math.BigDecimal s)
          Stores the starting price for the Dutch auction.
 void setStartTime(java.sql.Timestamp s)           Stores the starting date and time for the auction.
 

Field Detail
public static final java.lang.String COPYRIGHT
Copyright statement.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name. This is used if there is no record found in the CMDREG table.
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
The full class name for this interface file.
See Also:
Constant Field Values

AUCTION_BASE_TIMESTAMP

public static final java.sql.Timestamp AUCTION_BASE_TIMESTAMP
The timestamp for the auction.
Method Detail

getAuction

public com.ibm.commerce.negotiation.objects.AuctionAccessBean getAuction()
Returns the access bean representing the auction.
Returns:
the AuctionAccessBean

setBidRuleId

public void setBidRuleId(java.lang.Long br_id)
                  throws ECException
Stores the identifier of the bid control rule used by the auction.
Parameters:
br_id - is the bid rule ID.
Throws:
throws - ECException if anything goes wrong.
ECException

setCloseType

public void setCloseType(int aType)
                  throws ECException
Stores an integer representing the auction close type.

Auction closing rule has the following valid values:

  1. 1=auction closes at a fixed end time.
  2. 2=auction closes if a specified amount of time has elapsed since the last bid.
  3. 3=based on logical OR between 1 and 2.
  4. 4=based on logical AND between 1 and 2.
Parameters:
aType -
ECException

setCurrentAskPrice

public void setCurrentAskPrice(java.math.BigDecimal aPrice)
                        throws ECException
Stores the current asking price for the item on a Dutch auction.
Parameters:
aPrice -
ECException

setDeposit

public void setDeposit(java.math.BigDecimal amount)
                throws ECException
Stores the value of the deposit that should accompany each bid for the auction.
Parameters:
amount -
ECException

setDurationDays

public void setDurationDays(java.lang.Integer param)
Stores the number of days between successive bids for which the auction would stay active.
Parameters:
param - is the number of days.

setDurationTime

public void setDurationTime(java.lang.Integer hours,
                            java.lang.Integer minutes)
Hours and minute for the duration field on auction closing rule.
Parameters:
hours -
minutes -

setDurationTimestamp

public void setDurationTimestamp(java.sql.Timestamp dur)
                          throws ECException
Stores the duration timestamp.
Parameters:
dur - is the timestamp.
ECException

setEndTime

public void setEndTime(java.sql.Timestamp end)
                throws ECException
Stores the end date and time for the auction.
Parameters:
end - is the timestamp.
ECException

setFulfillmentCenterId

public void setFulfillmentCenterId(java.lang.Integer newFulfillmentCenterId)
                            throws ECException
Stores the identifier for the fulfillment center.
Parameters:
newFulfillmentCenterId -
ECException

setLongDescription

public void setLongDescription(java.lang.Integer langid,
                               java.lang.String ld)
                        throws ECException
Stores the long description for the auction for the specified language.
Parameters:
langid - Language Id.
ld - Long description.
ECException

setPricingRuleType

public void setPricingRuleType(java.lang.String s)
                        throws ECException
Stores the pricing rule for the auction.

ND for nondiscriminative, D for discriminative.

Parameters:
s - is the string.
ECException

setProductDisplayPage

public void setProductDisplayPage(java.lang.String s)
                           throws ECException
Stores the path and name of the product display page.
Parameters:
s - is the page name.
ECException

setQuantity

public void setQuantity(java.lang.Double quant)
                 throws ECException
Stores the quantity of the item on auction.
Parameters:
quant - is the quantity.
ECException

setReservationId

public void setReservationId(java.lang.Long v)
Stores the identifier for the reservation.
Parameters:
v -

setReservePrice

public void setReservePrice(java.math.BigDecimal aPrice)
                     throws ECException
Stores the minimum price for which the item will be sold.
ECException

setRuleDisplayPage

public void setRuleDisplayPage(java.lang.String s)
                        throws ECException
Stores the path and name of the web page that displays the auction rules.
Parameters:
s - is the rule page name.
ECException

setShortDescription

public void setShortDescription(java.lang.Integer langid,
                                java.lang.String s)
                         throws ECException
Stores the short description for the specified language.
Parameters:
langid - The language Id.
s - The short description.
ECException

setStartPrice

public void setStartPrice(java.math.BigDecimal s)
                   throws ECException
Stores the starting price for the Dutch auction.
Parameters:
s - is the price.
ECException

setStartTime

public void setStartTime(java.sql.Timestamp s)
                  throws ECException
Stores the starting date and time for the auction.
Parameters:
s - is the time stamp.
ECException