com.ibm.commerce.negotiation.commands

Class AuctionBaseCmdImpl

    • Field Detail

      • COPYRIGHT

        public static final java.lang.String COPYRIGHT
        IBM copyright notice field.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AuctionBaseCmdImpl

        public AuctionBaseCmdImpl()
        AuctionBaseCmdImpl default constructor.
    • Method Detail

      • getAuctionReferenceNumber

        public java.lang.Long getAuctionReferenceNumber()
        Gets auction reference number.
        Returns:
        Auction reference number.
      • getBidRule

        public java.lang.String getBidRule()
        Gets bid rule ID.
        Returns:
        The bid rule ID as a String.
      • getCurrency

        public java.lang.String getCurrency()
        Gets the currency string for the auction.
        Returns:
        The three characters currency string. (for example, USD )
      • getCurrentAskPrice

        public java.math.BigDecimal getCurrentAskPrice()
        Gets current dutch auction price.
        Returns:
        The current asks price.
      • getCurrentAvailableQuantity

        public java.lang.String getCurrentAvailableQuantity()
        Gets current available quantity for the auction.
        Returns:
        The current quantity as a string.
      • getDayDuration

        public java.lang.String getDayDuration()
        Gets the days for the duration.
        Returns:
        The days
      • getDeposit

        public java.lang.String getDeposit()
        Gets the deposit amount required by the auction.
        Returns:
        The deposit
      • getEndDate

        public java.lang.String getEndDate()
        Gets auction's end date.
        Returns:
        The end date as a string in format of yyyy-mm-dd.
      • getEndTime

        public java.lang.String getEndTime()
        Gets auction's end time.
        Returns:
        The end time as a string in format of hh:mm:ss
      • getErrorContent

        public java.util.Hashtable getErrorContent()
        Gets error content.
        Returns:
        The hashtable contains error codes.
      • getErrorFlag

        public boolean getErrorFlag()
        Gets error flag.
        Returns:
        the error flag.
      • getFulfillmentCenterId

        public java.lang.Integer getFulfillmentCenterId()
        Gets fulfillment Center ID.
        Returns:
        The fulfillment Center ID.
      • getLanguageId

        public java.lang.Integer getLanguageId()
        Gets language ID.
        Returns:
        the language ID.
      • getLongDescription

        public java.lang.String getLongDescription()
        Gets auction's long description.
        Returns:
        The long description.
      • getMinBid

        public java.math.BigDecimal getMinBid()
        Gets reserve price for the auction.
        Returns:
        the price.
      • getOwnerId

        public java.lang.Long getOwnerId()
        Gets auction's owner ID.
        Returns:
        The member ID.
      • getPrice

        public java.lang.String getPrice()
        Gets pricing policy type that is used to determine the winner's final winning price.

        D for discriminative, ND for non-discriminative.

        Returns:
        the string.
      • getProductMacro

        public java.lang.String getProductMacro()
        Gets product display page name for auction.
        Returns:
        the page path and name.
      • getProductNumber

        public java.lang.String getProductNumber()
        Gets the ID for the product that is being put on auction.
        Returns:
        The catalog entry ID.
      • getQuantity

        public java.lang.String getQuantity()
        Gets quantity of the product being put on auction.
        Returns:
        the quantity as a string.
      • getReservationId

        public java.lang.Long getReservationId()
        Gets the product reservation ID for the auction.
        Returns:
        reservation ID.
      • getRuleMacro

        public java.lang.String getRuleMacro()
        Gets rule display page name for the auction.
        Returns:
        The rule page name and path.
      • getRuleType

        public java.lang.String getRuleType()
        Gets auction closing type.

        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.
        Returns:
        the rule type.
      • getShortDescription

        public java.lang.String getShortDescription()
        Gets short description for the auction.
        Returns:
        the string.
      • getStartDate

        public java.lang.String getStartDate()
        Gets auction's start date.
        Returns:
        the date as a string in the format of yyyy-mm-dd.
      • getStartPrice

        public java.math.BigDecimal getStartPrice()
        Gets Dutch auction's open price.
        Returns:
        the price.
      • getStartTime

        public java.lang.String getStartTime()
        Gets auction start time.
        Returns:
        the start time as a string in the format of hh:mm:ss
      • getTimeDuration

        public java.lang.String getTimeDuration()
        Gets auction's time duration in format of 00:00:00 (hour:min:sec)
        Returns:
        java.lang.String
      • getToolXMLObject

        public java.util.Hashtable getToolXMLObject()
        Gets Tools framework XML object.
        Returns:
        java.util.Hashtable
      • getType

        public java.lang.String getType()
        Gets auction type
        Returns:
        java.lang.String
      • getViewTaskName

        public java.lang.String getViewTaskName()
        Gets the auction view task name
        Returns:
        java.lang.String
      • getWizardNavagationFile

        public java.lang.String getWizardNavagationFile()
        Gets tools frame wizard navigation file.
        Returns:
        java.lang.String
      • isErrorFlag

        public boolean isErrorFlag()
        Check to see if any error occured.
        Returns:
        true if error occured, false otherwise.
      • isReadyToCallExecute

        public boolean isReadyToCallExecute()
        isReadyToCallExecute method comment.
        Specified by:
        isReadyToCallExecute in interface com.ibm.websphere.command.Command
        Overrides:
        isReadyToCallExecute in class AbstractECTargetableCommand
        Returns:
        true if it is ready, false otherwise.
      • reset

        public void reset()
        reset method comment.
        Specified by:
        reset in interface com.ibm.websphere.command.Command
        Overrides:
        reset in class AbstractECTargetableCommand
      • setAuctionReferenceNumber

        public void setAuctionReferenceNumber(java.lang.Long newAuctionReferenceNumber)
        Sets auction reference number
        Parameters:
        newAuctionReferenceNumber -
      • setAuctionReferenceNumberUrlName

        public void setAuctionReferenceNumberUrlName(java.lang.String name,
                                                     boolean isReq)
        Sets auction reference number (also known as auction ID)
        Parameters:
        name - The URL name for the auction ID.
        isReq - Whether is parameter is required.
      • setBidRuleUrlName

        public void setBidRuleUrlName(java.lang.String name,
                                      boolean isReq)
                               throws ECApplicationException
        Gets bid rule ID from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setBidRuleUrlName in interface AuctionBaseCmd
        Parameters:
        name - The URL name for the bid rule ID.
        isReq - Whether is parameter is required.
        Throws:
        ECApplicationException - is raised with message ERR_TOOLS_AUCTION_REQUIRE when the bid rule is invalid and is required. Raised with message _ERR_TOOLS_AUCTION_BAD_PARAMETER when the bid rule is invalid.
        java.lang.NumberFormatException - is raised with message _ERR_TOOLS_AUCTION_INVALID_NUMBER when the format of the bid rule is invalid.
      • setCurrency

        public void setCurrency(java.lang.String newCurrency)
                         throws ECApplicationException
        Sets auction's currency string.
        Parameters:
        newCurrency -
        Throws:
        ECApplicationException - is thrown when the currency is invalid.
      • setCurrencyUrlName

        public void setCurrencyUrlName(java.lang.String urlName,
                                       boolean isReq)
        Gets the currency string from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setCurrencyUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for currency string.
        isReq - Whether is parameter is required.
      • setCurrentAskPriceUrlName

        public void setCurrentAskPriceUrlName(java.lang.String name,
                                              boolean isReq)
        Gets current ask price from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setCurrentAskPriceUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the current asks price.
        isReq - Whether is parameter is required.
      • setCurrentAvailableQuantity

        public void setCurrentAvailableQuantity(java.lang.String q)
        Sets current quantity. This quantity is used by Dutch auction type only.
        Parameters:
        q - is the current available quantity.
      • setCurrentAvailableQuantityUrlName

        public void setCurrentAvailableQuantityUrlName(java.lang.String name,
                                                       boolean isReq)
        Gets current available quantity from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setCurrentAvailableQuantityUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the current available quantity.
        isReq - Whether is parameter is required.
      • setDayDurationUrlName

        public void setDayDurationUrlName(java.lang.String name,
                                          boolean isReq)
        Gets duration days from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setDayDurationUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for duration days.
        isReq - Whether is parameter is required.
      • setDepositUrlName

        public void setDepositUrlName(java.lang.String name,
                                      boolean isReq)
        Gets deposit amount from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setDepositUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for deposit.
        isReq - Whether is parameter is required.
      • setEndDateUrlName

        public void setEndDateUrlName(java.lang.String name,
                                      boolean isReq)
        Gets auction's end date from the WebSphere Commerce tools framework XML object, and sets it for the command.

        Format is yyyy-mm-dd.

        Specified by:
        setEndDateUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the end date.
        isReq - Whether is parameter is required.
      • setEndTimeUrlName

        public void setEndTimeUrlName(java.lang.String name,
                                      boolean isReq)
        Gets auction's end time from the WebSphere Commerce tools framework XML objects, and sets it for the command.

        The format is hh:mm:ss.

        Specified by:
        setEndTimeUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the end time.
        isReq - Whether is parameter is required.
      • setErrorContent

        public void setErrorContent(java.util.Hashtable newErrorContent)
        Sets error content
        Parameters:
        newErrorContent - java.util.Hashtable
      • setErrorFlag

        public void setErrorFlag(boolean newErrorFlag)
        Sets error flag.
        Parameters:
        newErrorFlag -
      • setFulfillmentCenterIdUrlName

        public void setFulfillmentCenterIdUrlName(java.lang.String name,
                                                  boolean isReq)
        Gets fulfillment center ID from the WebSphere Commerce tools framework XML object, and sets it for the command.

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

        Specified by:
        setFulfillmentCenterIdUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the fulfillment center ID.
        isReq - Whether is parameter is required.
      • setLanguageIdUrlName

        public void setLanguageIdUrlName(java.lang.String name,
                                         boolean isReq)
        Gets language ID from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setLanguageIdUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the language ID.
        isReq - Whether is parameter is required.
      • setLongDescriptionUrlName

        public void setLongDescriptionUrlName(java.lang.String urlName,
                                              boolean isReq)
                                       throws ECApplicationException
        Gets auction's long description from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setLongDescriptionUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the long description.
        isReq - Whether is parameter is required.
        Throws:
        ECApplicationException - is thrown when the URL is invalid.
      • setMinBidUrlName

        public void setMinBidUrlName(java.lang.String name,
                                     boolean isReq)
        Gets auction's reserve price from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setMinBidUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the end date.
        isReq - Whether is parameter is required.
      • setOwnerId

        public void setOwnerId(java.lang.Long id)
        Sets auction owner ID
        Parameters:
        name - java.lang.Long
      • setOwnerIdUrlName

        public void setOwnerIdUrlName(java.lang.String name,
                                      boolean isReq)
        Gets auction's owner ID from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setOwnerIdUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the owner ID.
        isReq - Whether is parameter is required.
      • setPriceUrlName

        public void setPriceUrlName(java.lang.String name,
                                    boolean isReq)
        Gets auction's close pricing policy type(discriminative or non-discriminative) from the WebSphere Commerce tools framework XML object, and sets it for the command.

        ND for nondiscriminative, D for discriminative.

        Specified by:
        setPriceUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the close pricing policy type.
        isReq - Whether is parameter is required.
      • setProductMacroUrlName

        public void setProductMacroUrlName(java.lang.String name,
                                           boolean isReq)
        Gets auction's product display page name from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setProductMacroUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the product display page name.
        isReq - Whether is parameter is required.
      • setProductNumberUrlName

        public void setProductNumberUrlName(java.lang.String name,
                                            boolean isReq)
        Gets auction's product (also known as catalog entry) ID from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setProductNumberUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the product ID (Catalog Entry ID).
        isReq - Whether is parameter is required.
      • setQuantity

        public void setQuantity(java.lang.String q)
        Sets auction quantity
        Parameters:
        q - is the quantity.
      • setQuantityUrlName

        public void setQuantityUrlName(java.lang.String name,
                                       boolean isReq)
        Gets auction's quantity from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setQuantityUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the quantity.
        isReq - Whether is parameter is required.
      • setReservationId

        public void setReservationId(java.lang.Long newReservationId)
        Sets reservation identifier.
        Parameters:
        newReservationId -
      • setRuleMacroUrlName

        public void setRuleMacroUrlName(java.lang.String name,
                                        boolean isReq)
        Gets auction's rule display page name from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setRuleMacroUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the rule display page name.
        isReq - Whether is parameter is required.
      • setRuleTypeUrlName

        public void setRuleTypeUrlName(java.lang.String name,
                                       boolean isReq)
        Gets auction's closing type (fixed time closing, and so forth.) from the WebSphere Commerce tools framework XML object, and sets 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.
        Specified by:
        setRuleTypeUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the auction closing type.
        isReq - Whether is parameter is required.
      • setShortDescriptionUrlName

        public void setShortDescriptionUrlName(java.lang.String name,
                                               boolean isReq)
                                        throws ECApplicationException
        Gets auction's short description from the WebSphere Commerce tools framework XML objects, and sets it for the command.
        Specified by:
        setShortDescriptionUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the short description.
        isReq - Whether is parameter is required.
        Throws:
        ECApplicationException - is thrown with message _ERR_TOOLS_AUCTION_REQUIRED when the short description is missing and is required.
      • setStartDateUrlName

        public void setStartDateUrlName(java.lang.String name,
                                        boolean isReq)
                                 throws ECApplicationException
        Gets auction's start date from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setStartDateUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the start date.
        isReq - Whether is parameter is required.
        Throws:
        ECApplicationException - is thrown with message _ERR_TOOLS_AUCTION_REQUIRED when the start date is missing and is required.
      • setStartPrice

        public void setStartPrice(java.math.BigDecimal newStartPrice)
        Sets start price for a Dutch auction.
        Parameters:
        newStartPrice - java.math.BigDecimal
      • setStartPriceUrlName

        public void setStartPriceUrlName(java.lang.String name,
                                         boolean isReq)
        Gets auction's start date from the WebSphere Commerce tools framework XML object, and sets it for the command.
        Specified by:
        setStartPriceUrlName in interface AuctionBaseCmd
        Parameters:
        name - The name for the start date.
        isReq - Whether is parameter is required.
      • setStartTimeUrlName

        public void setStartTimeUrlName(java.lang.String name,
                                        boolean isReq)
        Gets auction's start time from the WebSphere Commerce tools framework XML objects, and sets it for the command.

        The format is hh:mm:ss.

        Specified by:
        setStartTimeUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for the start time.
        isReq - Whether is parameter is required.
      • setTimeDurationUrlName

        public void setTimeDurationUrlName(java.lang.String name,
                                           boolean isReq)
        Gets duration time string (in hh:mm:ss format) from the WebSphere Commerce tools framework XML objects, and sets it for the command.
        Specified by:
        setTimeDurationUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for duration time.
        isReq - Whether is parameter is required.
      • setToolXMLObject

        public void setToolXMLObject(java.util.Hashtable newToolXMLObject)
        Sets Tools framework XML objects
        Parameters:
        newToolXMLObject -
      • setTypeUrlName

        public void setTypeUrlName(java.lang.String name,
                                   boolean isReq)
                            throws ECApplicationException
        Gets auction type string from the WebSphere Commerce tools framework XML object, and sets it for the command.
        1. O for open cry auction type.
        2. SB for sealed bid auction type.
        3. D for Dutch auction type.
        Specified by:
        setTypeUrlName in interface AuctionBaseCmd
        Parameters:
        s - The name for auction type.
        isReq - Whether is parameter is required.
        Throws:
        ECApplicationException - is raised with message _ERR_TOOLS_AUCTION_REQUIRED if the name is missing and is required. Raised with message _ERR_TOOLS_AUCTION_INVALID_TYPE is the auction type is invalid.
      • setViewTaskName

        public void setViewTaskName(java.lang.String newViewTaskName)
        Sets auction creation view task name. The view task name specifies what view to execute when create auction completes.
        Parameters:
        newViewTaskName -