Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum SimpleItemSortCodeType

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

public enum SimpleItemSortCodeType
extends java.lang.Enum<SimpleItemSortCodeType>

Java class for SimpleItemSortCodeType.

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

 <simpleType name="SimpleItemSortCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="BestMatch"/>
     <enumeration value="CustomCode"/>
     <enumeration value="EndTime"/>
     <enumeration value="BidCount"/>
     <enumeration value="Country"/>
     <enumeration value="CurrentBid"/>
     <enumeration value="Distance"/>
     <enumeration value="StartDate"/>
     <enumeration value="BestMatchCategoryGroup"/>
     <enumeration value="PricePlusShipping"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
BEST_MATCH
          Sorts items by Best Match, and no sort order applies.
BEST_MATCH_CATEGORY_GROUP
          Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category.
BID_COUNT
          Sorts by number of bids on the item, in ascending or descending order according to the SortOrder value.
COUNTRY
          Sorts by country; no sort order can be specified.
CURRENT_BID
          Sorts by current bid; descending order only.
CUSTOM_CODE
          This value is reserved for future or internal use.
DISTANCE
          Sorts by distance; ascending order only.
END_TIME
          Sorts by the end time of the listing, in ascending or descending order according to the SortOrder value.
PRICE_PLUS_SHIPPING
          Sorts by total cost, which is item cost plus shipping cost.
START_DATE
          Sorts by the start time of the listing; recently-listed first.
 
Method Summary
static SimpleItemSortCodeType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static SimpleItemSortCodeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SimpleItemSortCodeType[] 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

BEST_MATCH

public static final SimpleItemSortCodeType BEST_MATCH
Sorts items by Best Match, and no sort order applies. If specified, then Best Match sort also applies to CategoryHistogram.


CUSTOM_CODE

public static final SimpleItemSortCodeType CUSTOM_CODE
This value is reserved for future or internal use.


END_TIME

public static final SimpleItemSortCodeType END_TIME
Sorts by the end time of the listing, in ascending or descending order according to the SortOrder value.


BID_COUNT

public static final SimpleItemSortCodeType BID_COUNT
Sorts by number of bids on the item, in ascending or descending order according to the SortOrder value.


COUNTRY

public static final SimpleItemSortCodeType COUNTRY
Sorts by country; no sort order can be specified.


CURRENT_BID

public static final SimpleItemSortCodeType CURRENT_BID
Sorts by current bid; descending order only.


DISTANCE

public static final SimpleItemSortCodeType DISTANCE
Sorts by distance; ascending order only.


START_DATE

public static final SimpleItemSortCodeType START_DATE
Sorts by the start time of the listing; recently-listed first.


BEST_MATCH_CATEGORY_GROUP

public static final SimpleItemSortCodeType BEST_MATCH_CATEGORY_GROUP
Sorts by BestMatchCategoryGroup, so results are grouped by Best Match within a category.


PRICE_PLUS_SHIPPING

public static final SimpleItemSortCodeType PRICE_PLUS_SHIPPING
Sorts by total cost, which is item cost plus shipping cost. If SortOrder is included and set to 'Ascending', items are sorted in the following order: Lowest total cost (for items where shipping was properly specified); then freight-shipping items (lowest to highest); and finally, items for which shipping was not specified (lowest to highest).

Method Detail

values

public static SimpleItemSortCodeType[] 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 (SimpleItemSortCodeType c : SimpleItemSortCodeType.values())
    System.out.println(c);

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

valueOf

public static SimpleItemSortCodeType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

fromValue

public static SimpleItemSortCodeType fromValue(java.lang.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.