com.ibm.commerce.negotiation.commands
Interface AuctionBaseCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Subinterfaces:
CreateAuctionCmd, CreateAuctionStyleCmd, ModifyAuctionCmd, ModifyAuctionStyleCmd
All Known Implementing Classes:
AuctionBaseCmdImpl

public interface AuctionBaseCmd
extends ToolsControllerCommand

Auction Base command interface.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
           
 
Fields inherited from interface com.ibm.commerce.tools.command.ToolsControllerCommand
NAME
 
Method Summary
 void setBidRuleUrlName(java.lang.String s, boolean isReq)
          Get bid rule id from Tools Framework's XML Object, and set it for the command.
 void setCurrencyUrlName(java.lang.String s, boolean isReq)
          Get the currency string from Tools Framework's XML Object, and set it for the command.
 void setCurrentAskPriceUrlName(java.lang.String s, boolean isReq)
          Get current ask price from Tools Framework's XML Object, and set it for the command.
 void setCurrentAvailableQuantityUrlName(java.lang.String s, boolean isReq)
          Get current available quantity from Tools Framework's XML Object, and set it for the command.
 void setDayDurationUrlName(java.lang.String s, boolean isReq)
          Get duration days from Tools Framework's XML Object, and set it for the command.
 void setDepositUrlName(java.lang.String s, boolean isReq)
          Get deposit amount from Tools Framework's XML Object, and set it for the command.
 void setEndDateUrlName(java.lang.String s, boolean isReq)
          Get auction's end date from Tools Framework's XML Object, and set it for the command.
 void setEndTimeUrlName(java.lang.String s, boolean isReq)
          Get auction's end time from Tools Framework's XML Object, and set it for the command.
 void setFulfillmentCenterIdUrlName(java.lang.String s, boolean isReq)
          Get fulfillment center id from Tools Framework's XML Object, and set it for the command.
 void setLanguageIdUrlName(java.lang.String s, boolean isReq)
          Get language id from Tools Framework's XML Object, and set it for the command.
 void setLongDescriptionUrlName(java.lang.String s, boolean isReq)
          Get auction's long description from Tools Framework's XML Object, and set it for the command.
 void setMinBidUrlName(java.lang.String s, boolean isReq)
          Get auction's reserve price from Tools Framework's XML Object, and set it for the command.
 void setOwnerIdUrlName(java.lang.String s, boolean isReq)
          Get auction's owner id from Tools Framework's XML Object, and set it for the command.
 void setPriceUrlName(java.lang.String s, boolean isReq)
          Get auction's close pricing policy type(discriminative or non-discriminative) from Tools Framework's XML Object, and set it for the command.
 void setProductMacroUrlName(java.lang.String s, boolean isReq)
          Get auction's product display page name from Tools Framework's XML Object, and set it for the command.
 void setProductNumberUrlName(java.lang.String s, boolean isReq)
          Get auction's product id from Tools Framework's XML Object, and set it for the command.
 void setQuantityUrlName(java.lang.String s, boolean isReq)
          Get auction's quantity from Tools Framework's XML Object, and set it for the command.
 void setRuleMacroUrlName(java.lang.String s, boolean isReq)
          Get auction's rule display page name from Tools Framework's XML Object, and set it for the command.
 void setRuleTypeUrlName(java.lang.String s, boolean isReq)
          Get auction's closing type (fixed time closing, etc.) from Tools Framework's XML Object, and set it for the command.
 void setShortDescriptionUrlName(java.lang.String s, boolean isReq)
          Get auction's short description from Tools Framework's XML Object, and set it for the command.
 void setStartDateUrlName(java.lang.String s, boolean isReq)
          Get auction's start date from Tools Framework's XML Object, and set it for the command.
 void setStartPriceUrlName(java.lang.String s, boolean isReq)
          Get Dutch auction's start price from Tools Framework's XML Object, and set it for the command.
 void setStartTimeUrlName(java.lang.String s, boolean isReq)
          Get auction's start time from Tools Framework's XML Object, and set it for the command.
 void setTimeDurationUrlName(java.lang.String s, boolean isReq)
          Get duration time string (in hh:mm:ss format) from Tools Framework's XML Object, and set it for the command.
 void setTypeUrlName(java.lang.String s, boolean isReq)
          Get auction type string from Tools Framework's XML Object, and set it for the command.
 
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

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
Method Detail

setBidRuleUrlName

public void setBidRuleUrlName(java.lang.String s,
                              boolean isReq)
                       throws ECException
Get bid rule id from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for bid rule id.
isReq - Whether is parameter is required.

setCurrencyUrlName

public void setCurrencyUrlName(java.lang.String s,
                               boolean isReq)
                        throws ECException
Get the currency string from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for currency string.
isReq - Whether is parameter is required.

setCurrentAskPriceUrlName

public void setCurrentAskPriceUrlName(java.lang.String s,
                                      boolean isReq)
                               throws ECException
Get current ask price from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the current ask price.
isReq - Whether is parameter is required.

setCurrentAvailableQuantityUrlName

public void setCurrentAvailableQuantityUrlName(java.lang.String s,
                                               boolean isReq)
                                        throws ECException
Get current available quantity from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the current available quantity.
isReq - Whether is parameter is required.

setDayDurationUrlName

public void setDayDurationUrlName(java.lang.String s,
                                  boolean isReq)
                           throws ECException
Get duration days from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for duration days.
isReq - Whether is parameter is required.

setDepositUrlName

public void setDepositUrlName(java.lang.String s,
                              boolean isReq)
                       throws ECException
Get deposit amount from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for deposit.
isReq - Whether is parameter is required.

setEndDateUrlName

public void setEndDateUrlName(java.lang.String s,
                              boolean isReq)
                       throws ECException
Get auction's end date from Tools Framework's XML Object, and set it for the command.

The format is yyyy-mm-dd.

Parameters:
s - The name for the end date.
isReq - Whether is parameter is required.

setEndTimeUrlName

public void setEndTimeUrlName(java.lang.String s,
                              boolean isReq)
                       throws ECException
Get auction's end time from Tools Framework's XML Object, and set it for the command.

The format is hh:mm:ss.

Parameters:
s - The name for the end time.
isReq - Whether is parameter is required.

setFulfillmentCenterIdUrlName

public void setFulfillmentCenterIdUrlName(java.lang.String s,
                                          boolean isReq)
                                   throws ECException
Get fulfillment center id from Tools Framework's XML Object, and set it for the command.

The current implementation is to resolve the fulfillment center based on product id and quantity instead of setting directly.

Parameters:
s - The name for the fulfillment center id.
isReq - Whether is parameter is required.

setLanguageIdUrlName

public void setLanguageIdUrlName(java.lang.String s,
                                 boolean isReq)
                          throws ECException
Get language id from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the language id.
isReq - Whether is parameter is required.

setLongDescriptionUrlName

public void setLongDescriptionUrlName(java.lang.String s,
                                      boolean isReq)
                               throws ECException
Get auction's long description from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the long description.
isReq - Whether is parameter is required.

setMinBidUrlName

public void setMinBidUrlName(java.lang.String s,
                             boolean isReq)
                      throws ECException
Get auction's reserve price from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the end date.
isReq - Whether is parameter is required.

setOwnerIdUrlName

public void setOwnerIdUrlName(java.lang.String s,
                              boolean isReq)
                       throws ECException
Get auction's owner id from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the owner id.
isReq - Whether is parameter is required.

setPriceUrlName

public void setPriceUrlName(java.lang.String s,
                            boolean isReq)
                     throws ECException
Get auction's close pricing policy type(discriminative or non-discriminative) from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the close pricing policy type.
isReq - Whether is parameter is required.

setProductMacroUrlName

public void setProductMacroUrlName(java.lang.String s,
                                   boolean isReq)
                            throws ECException
Get auction's product display page name from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the product display page name.
isReq - Whether is parameter is required.

setProductNumberUrlName

public void setProductNumberUrlName(java.lang.String s,
                                    boolean isReq)
                             throws ECException
Get auction's product id from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the product id (Catalog Entry id).
isReq - Whether is parameter is required.

setQuantityUrlName

public void setQuantityUrlName(java.lang.String s,
                               boolean isReq)
                        throws ECException
Get auction's quantity from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the quantity.
isReq - Whether is parameter is required.

setRuleMacroUrlName

public void setRuleMacroUrlName(java.lang.String s,
                                boolean isReq)
                         throws ECException
Get auction's rule display page name from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the rule display page name.
isReq - Whether is parameter is required.

setRuleTypeUrlName

public void setRuleTypeUrlName(java.lang.String s,
                               boolean isReq)
                        throws ECException
Get auction's closing type (fixed time closing, etc.) from Tools Framework's XML Object, and set it for the command.

Auction closing rule has the following valid values:

  1. 1=at a fixed end time.
  2. 2=if a specified amount of time has elapsed since the last bid.
  3. 3=based on logical OR 1 and 2.
  4. 4=based on logical AND 1 and 2.
Parameters:
s - The name for the auction closing type.
isReq - Whether is parameter is required.

setShortDescriptionUrlName

public void setShortDescriptionUrlName(java.lang.String s,
                                       boolean isReq)
                                throws ECException
Get auction's short description from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the short description.
isReq - Whether is parameter is required.

setStartDateUrlName

public void setStartDateUrlName(java.lang.String s,
                                boolean isReq)
                         throws ECException
Get auction's start date from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the start date.
isReq - Whether is parameter is required.

setStartPriceUrlName

public void setStartPriceUrlName(java.lang.String s,
                                 boolean isReq)
                          throws ECException
Get Dutch auction's start price from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for the start price.
isReq - Whether is parameter is required.

setStartTimeUrlName

public void setStartTimeUrlName(java.lang.String s,
                                boolean isReq)
                         throws ECException
Get auction's start time from Tools Framework's XML Object, and set it for the command.

The format is hh:mm:ss.

Parameters:
s - The name for the start time.
isReq - Whether is parameter is required.

setTimeDurationUrlName

public void setTimeDurationUrlName(java.lang.String s,
                                   boolean isReq)
                            throws ECException
Get duration time string (in hh:mm:ss format) from Tools Framework's XML Object, and set it for the command.
Parameters:
s - The name for duration time.
isReq - Whether is parameter is required.

setTypeUrlName

public void setTypeUrlName(java.lang.String s,
                           boolean isReq)
                    throws ECException
Get auction type string from Tools Framework's XML Object, and set it for the command.
  1. O for open cry auction type.
  2. SB for sealed bid auction type.
  3. D for Dutch auction type.
Parameters:
s - The name for auction type.
isReq - Whether is parameter is required.