Changes since
the last release

com.ebay.soap.eBLBaseComponents
Enum MyMessagesFolderOperationCodeType

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

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

Java class for MyMessagesFolderOperationCodeType.

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

 <simpleType name="MyMessagesFolderOperationCodeType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}token">
     <enumeration value="Display"/>
     <enumeration value="Rename"/>
     <enumeration value="Remove"/>
     <enumeration value="CustomCode"/>
   </restriction>
 </simpleType>
 
Note: Per JAXB standards, underscores are added to separate words in enumerations (e.g., PayPal becomes PAY_PAL).


Enum Constant Summary
CUSTOM_CODE
          Reserved for future or internal use.
DISPLAY
          This enumeration value is used to create one or more custom folders in My eBay Messages.
REMOVE
          This enumeration value is used to remove one or more custom folders in My eBay Messages.
RENAME
          This enumeration value is used to rename one or more existing folders in My eBay Messages.
 
Method Summary
static MyMessagesFolderOperationCodeType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static MyMessagesFolderOperationCodeType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MyMessagesFolderOperationCodeType[] 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

DISPLAY

public static final MyMessagesFolderOperationCodeType DISPLAY
This enumeration value is used to create one or more custom folders in My eBay Messages. For a 'Display' operation, the new folder name(s) are specified in one or more FolderName fields. The maximum length of a folder name is 15 characters. Up to 10 new folders can be created with one ReviseMyMessagesFolders call, but this is also limited by how many custom folders exist at the time of the call, as only a maximum of 10 custom folders are supported in My eBay Messages.


RENAME

public static final MyMessagesFolderOperationCodeType RENAME
This enumeration value is used to rename one or more existing folders in My eBay Messages. For a 'Rename' operation, the unique identifier(s) of the message folder(s) to rename are specified in one or more FolderID fields, and the new name for the folder(s) are specified in one or more FolderName fields.

The FolderID and FolderName values can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or these folder names and identifiers can be found by navigating to My eBay Messages (Folder ID values are displayed at the end of the browser's URL when that folder is opened).

The maximum length of a folder name is 15 characters. The Inbox and Sent folders cannot be renamed.

Note: If multiple folders will be renamed with one call, the user must pay close attention to the order of the FolderID and FolderName fields, as eBay will process these requests in order according to the placement of the the FolderID and FolderName fields. So, the existing folder identified by the first FolderID field in the request payload will get renamed to the folder name passed into the first FolderName field in the request payload, and so on.


REMOVE

public static final MyMessagesFolderOperationCodeType REMOVE
This enumeration value is used to remove one or more custom folders in My eBay Messages. For a 'Remove' operation, the folder(s) to remove are specified in one or more FolderID fields. The FolderID values for a My eBay Messages folders can be retrieved by calling GetMyMessages with a DetailLevel value set to ReturnSummary, or these folder IDs can be found by navigating to a specific folder in My eBay Messages, and the ID value for the opened folder is displayed at the end of the browser's URL.

A My eBay Messages folder must be empty before being removed, and an error is returned if a user tries to remove a non-empty folder.

The Inbox and Sent folders cannot be removed under any circumstance.


CUSTOM_CODE

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

Method Detail

values

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

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

valueOf

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