Changes since
the last release

com.ebay.sdk.call
Class ReviseMyMessagesFoldersCall

java.lang.Object
  extended by com.ebay.sdk.ApiCall
      extended by com.ebay.sdk.call.ReviseMyMessagesFoldersCall

public class ReviseMyMessagesFoldersCall
extends ApiCall

Wrapper class of the ReviseMyMessagesFolders call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.


Input property: Operation - Indicates the type of operation to perform on a specified My Messages folder. Operations include creating, renaming, removing, and restoring folders. Operations cannot be performed on the Inbox and Sent folders.
Input property: FolderID - An ID that uniquely identifies the My Messages folder to perform the operation on. This value is set by eBay and cannot be changed. Retrieve FolderIDs by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1.
Input property: FolderName - The name of a specified My Messages folder. Depending on the specified Operation, the value is an existing folder name or a new folder name. Retrieve existing FolderNames by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
ReviseMyMessagesFoldersCall()
          Constructor.
ReviseMyMessagesFoldersCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 long[] getFolderID()
          Gets the ReviseMyMessagesFoldersRequestType.folderID.
 String[] getFolderName()
          Gets the ReviseMyMessagesFoldersRequestType.folderName.
 MyMessagesFolderOperationCodeType getOperation()
          Gets the ReviseMyMessagesFoldersRequestType.operation.
 void reviseMyMessagesFolders()
          Renames, removes, or restores the specified My Messages folders for a given user.
 void setFolderID(long[] folderID)
          Sets the ReviseMyMessagesFoldersRequestType.folderID.
 void setFolderName(String[] folderName)
          Sets the ReviseMyMessagesFoldersRequestType.folderName.
 void setOperation(MyMessagesFolderOperationCodeType operation)
          Sets the ReviseMyMessagesFoldersRequestType.operation.
 
Methods inherited from class com.ebay.sdk.ApiCall
addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getBotBlock, getCallRetry, getDetailLevel, getEnableCompression, getEndUserIP, getErrorHandling, getInvocationID, getMessageID, getOutputSelector, getRequestXml, getResponseObject, getResponseXml, getSite, getWarningLevel, hasError, hasWarning, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEndUserIP, setErrorHandling, setInvocationID, setMessageID, setOutputSelector, setSite, setWarningLevel
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReviseMyMessagesFoldersCall

public ReviseMyMessagesFoldersCall()
Constructor.


ReviseMyMessagesFoldersCall

public ReviseMyMessagesFoldersCall(ApiContext apiContext)
Constructor.

Parameters:
apiContext - The ApiContext object to be used to make the call.
Method Detail

reviseMyMessagesFolders

public void reviseMyMessagesFolders()
                             throws ApiException,
                                    SdkException,
                                    Exception
Renames, removes, or restores the specified My Messages folders for a given user.

Throws:
ApiException
SdkException
Exception

getFolderID

public long[] getFolderID()
Gets the ReviseMyMessagesFoldersRequestType.folderID.

Returns:
long[]

setFolderID

public void setFolderID(long[] folderID)
Sets the ReviseMyMessagesFoldersRequestType.folderID.

Parameters:
folderID - long[]

getFolderName

public String[] getFolderName()
Gets the ReviseMyMessagesFoldersRequestType.folderName.

Returns:
String[]

setFolderName

public void setFolderName(String[] folderName)
Sets the ReviseMyMessagesFoldersRequestType.folderName.

Parameters:
folderName - String[]

getOperation

public MyMessagesFolderOperationCodeType getOperation()
Gets the ReviseMyMessagesFoldersRequestType.operation.

Returns:
MyMessagesFolderOperationCodeType

setOperation

public void setOperation(MyMessagesFolderOperationCodeType operation)
Sets the ReviseMyMessagesFoldersRequestType.operation.

Parameters:
operation - MyMessagesFolderOperationCodeType

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.