Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum DetailLevelCodeType

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

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

Java class for DetailLevelCodeType.

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

 <simpleType name="DetailLevelCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="ReturnAll"/>
     <enumeration value="ItemReturnDescription"/>
     <enumeration value="ItemReturnAttributes"/>
     <enumeration value="ItemReturnCategories"/>
     <enumeration value="ReturnSummary"/>
     <enumeration value="ReturnHeaders"/>
     <enumeration value="ReturnMessages"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
ITEM_RETURN_ATTRIBUTES
          For GetItem, returns Item Specifics and Pre-filled Item Information, if any.
ITEM_RETURN_CATEGORIES
          If this value is used, the primary category and, if applicable, the secondary category is returned.
ITEM_RETURN_DESCRIPTION
          Returns the description, plus the ListingDesigner node and some additional information if applicable
RETURN_ALL
          Returns all available data.
RETURN_HEADERS
          Returns message headers.
RETURN_MESSAGES
          Returns full message information.
RETURN_SUMMARY
          Returns the summary data.
 
Method Summary
static DetailLevelCodeType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static DetailLevelCodeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static DetailLevelCodeType[] 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

RETURN_ALL

public static final DetailLevelCodeType RETURN_ALL
Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


ITEM_RETURN_DESCRIPTION

public static final DetailLevelCodeType ITEM_RETURN_DESCRIPTION
Returns the description, plus the ListingDesigner node and some additional information if applicable


ITEM_RETURN_ATTRIBUTES

public static final DetailLevelCodeType ITEM_RETURN_ATTRIBUTES
For GetItem, returns Item Specifics and Pre-filled Item Information, if any. Also see the description of Item.ProductListingDetails for GetItem.


ITEM_RETURN_CATEGORIES

public static final DetailLevelCodeType ITEM_RETURN_CATEGORIES
If this value is used, the primary category and, if applicable, the secondary category is returned.


RETURN_SUMMARY

public static final DetailLevelCodeType RETURN_SUMMARY
Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See GetMyMessages for a code sample that demonstrates this.


RETURN_HEADERS

public static final DetailLevelCodeType RETURN_HEADERS
Returns message headers. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns header information, without body text, for the specified message ID or alert ID values. If you include a FolderID, header information is returned only for the messages and alerts in the specified folder.

If you do not include MessageIDs or AlertIDs, this detail level returns header information for Alerts and Messages as follows:
Note: Even when restricted by this detail level to return only header information, GetMyMessages may return a high volume of data.


RETURN_MESSAGES

public static final DetailLevelCodeType RETURN_MESSAGES
Returns full message information. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns message information for the specified message ID or alert ID values. If you include a FolderID, message information is returned only for the messages and alerts in the specified folder.

Method Detail

values

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

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

valueOf

public static DetailLevelCodeType 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 DetailLevelCodeType 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.