Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum BidActionCodeType

java.lang.Object
  extended by java.lang.Enum<BidActionCodeType>
      extended by com.ebay.soap.eBLBaseComponents.BidActionCodeType
All Implemented Interfaces:
Serializable, Comparable<BidActionCodeType>

public enum BidActionCodeType
extends Enum<BidActionCodeType>

Java class for BidActionCodeType.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="BidActionCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Unknown"/>
     <enumeration value="Bid"/>
     <enumeration value="NotUsed"/>
     <enumeration value="Retraction"/>
     <enumeration value="AutoRetraction"/>
     <enumeration value="Cancelled"/>
     <enumeration value="AutoCancel"/>
     <enumeration value="Absentee"/>
     <enumeration value="BuyItNow"/>
     <enumeration value="Purchase"/>
     <enumeration value="CustomCode"/>
     <enumeration value="Offer"/>
     <enumeration value="Counter"/>
     <enumeration value="Accept"/>
     <enumeration value="Decline"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
ABSENTEE
          This value is returned in the GetAllBidders call if an absentee bid was made, which means that eBay made a bid on the auction listing on behalf of the buyer, who has set a maximum bid threshold.
ACCEPT
          This value is used in a PlaceOffer call if the buyer is accepting a counter offer proposed by the seller.
AUTO_CANCEL
          This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically cancelled.
AUTO_RETRACTION
          This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically retracted.
BID
          This value is used in a PlaceOffer call if the buyer wants to bid on an auction listing.
BUY_IT_NOW
          This value is returned in the GetAllBidders call if the buyer purchased an item in an auction listing using the Buy It Now feature.
CANCELLED
          This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was cancelled.
COUNTER
          This value is used in a PlaceOffer call if the buyer is proposing a counter offer to the seller's proposed counter offer.
CUSTOM_CODE
          Reserved for future or internal use.
DECLINE
          This value is used in a PlaceOffer call if the buyer is declining a counter offer proposed by the seller.
NOT_USED
          This value is no longer applicable.
OFFER
          This value is used in a PlaceOffer call if the buyer is proposing a Best Offer to the seller.
PURCHASE
          This value is used in a PlaceOffer call if the buyer wants to purchase a fixed-price item or purchase an auction item enabled with the Buy It Now feature.
RETRACTION
          This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was retracted.
UNKNOWN
          This value indicates that the action or state is unknown.
 
Method Summary
static BidActionCodeType fromValue(String v)
           
 String value()
           
static BidActionCodeType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static BidActionCodeType[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

UNKNOWN

public static final BidActionCodeType UNKNOWN
This value indicates that the action or state is unknown.


BID

public static final BidActionCodeType BID
This value is used in a PlaceOffer call if the buyer wants to bid on an auction listing. If this value is used, the prospective buyer must also include the Offer.MaxBid field in the PlaceOffer call and specify the maximum amount that they are willing to bid in an attempt to win the auction. eBay will automatically rebid on behalf of the buyer each time the buyer is outbid up until the time when their Offer.MaxBid value threshold is met. The GetAllBidders call will return this value as well if the buyer has set up automatic bidding using a maximum bid threshold.


NOT_USED

public static final BidActionCodeType NOT_USED
This value is no longer applicable.


RETRACTION

public static final BidActionCodeType RETRACTION
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was retracted. This value cannot be used with the PlaceOffer call.


AUTO_RETRACTION

public static final BidActionCodeType AUTO_RETRACTION
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically retracted. This value cannot be used with the PlaceOffer call.


CANCELLED

public static final BidActionCodeType CANCELLED
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was cancelled. This value cannot be used with the PlaceOffer call.


AUTO_CANCEL

public static final BidActionCodeType AUTO_CANCEL
This value indicates that a buyer's Best Offer or a seller's or buyer's counter offer was automatically cancelled. This value cannot be used with the PlaceOffer call.


ABSENTEE

public static final BidActionCodeType ABSENTEE
This value is returned in the GetAllBidders call if an absentee bid was made, which means that eBay made a bid on the auction listing on behalf of the buyer, who has set a maximum bid threshold. This value is not applicable for the PlaceOffer call, as the buyer would use the Bid value instead, as well as setting a Offer.MaxBid value that would specify the maxium amount that the buyer is willing to bid in an attempt to win the auction.


BUY_IT_NOW

public static final BidActionCodeType BUY_IT_NOW
This value is returned in the GetAllBidders call if the buyer purchased an item in an auction listing using the Buy It Now feature. This value is not applicable for the PlaceOffer call, as the buyer would use the Purchase value instead.


PURCHASE

public static final BidActionCodeType PURCHASE
This value is used in a PlaceOffer call if the buyer wants to purchase a fixed-price item or purchase an auction item enabled with the Buy It Now feature. The GetAllBidders call will return this value as well if the buyer purchased the item. For items requiring immediate payment, the PlaceOffer call cannot be used for purchase.


CUSTOM_CODE

public static final BidActionCodeType CUSTOM_CODE
Reserved for future or internal use.


OFFER

public static final BidActionCodeType OFFER
This value is used in a PlaceOffer call if the buyer is proposing a Best Offer to the seller. The GetAllBidders call will return this value as well if the buyer proposed a Best Offer to the seller.


COUNTER

public static final BidActionCodeType COUNTER
This value is used in a PlaceOffer call if the buyer is proposing a counter offer to the seller's proposed counter offer. The GetAllBidders call will return this value as well if the buyer proposed a counter offer to the seller's counter offer.


ACCEPT

public static final BidActionCodeType ACCEPT
This value is used in a PlaceOffer call if the buyer is accepting a counter offer proposed by the seller. The GetAllBidders call will return this value as well if the buyer accepted a counter offer.


DECLINE

public static final BidActionCodeType DECLINE
This value is used in a PlaceOffer call if the buyer is declining a counter offer proposed by the seller. The GetAllBidders call will return this value as well if the buyer declined a counter offer.

Method Detail

values

public static BidActionCodeType[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (BidActionCodeType c : BidActionCodeType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static BidActionCodeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

value

public String value()

fromValue

public static BidActionCodeType fromValue(String v)

Changes since
the last release

The information contained in this document is proprietary and confidential. Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc. For information regarding a qualifying NDA, contact Developer Relations: developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.