Changes since
the last release

com.ebay.sdk.call
Class GetUserDisputesCall

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

public class GetUserDisputesCall
extends ApiCall

Wrapper class of the GetUserDisputes 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: DisputeFilterType - An inclusive filter that isolates the returned disputes to a certain type such as Item Not Received or Unpaid Item disputes. eBay Money Back Guarantee cases are not retrieved with this call, even if the ItemNotReceivedDisputes filter is included in the request.
Input property: DisputeSortType - The value and sequence to use to sort the returned disputes.
Input property: TimeFilter - Helper wrapper to set GetUserDisputesRequestType ModTimeFrom, ModTimeTo: TimeFrom sets GetUserDisputesRequestType.ModTimeFrom: A filter that retrieves disputes whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. See the eBay Features Guide for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeTo. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned. TimeTo sets GetUserDisputesRequestType.ModTimeTo: A filter that retrieves disputes whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. See the eBay Features Guide for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned.
Input property: Pagination - The virtual page number of the result set to display. A result set has a number of disputes divided into virtual pages, with 200 disputes per page. The response can only display one page. The first page in the result set is number 1. Required. If not specified, a warning is returned and Pagination.PageNumber is set to 1 by default.
Output property: ReturnedStartingDisputeID - The index of the first dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns a StartingDisputeID value of 1 and the second page returns a StartingDisputeID value of 201.
Output property: ReturnedEndingDisputeID - The index of the last dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns an EndingDisputeID value of 200 and the second page returns an EndingDisputeID value of 228.
Output property: ReturnedDisputeArray - The array of disputes returned.
Output property: ReturnedItemsPerPage - The number of disputes on each virtual page in the result set. The virtual page returned is determined by PageNumber.
Output property: ReturnedPageNumber - The page of the total result set returned in the call. The entire result set is virtual and the call returns only one page of it.
Output property: ReturnedDisputeFilterCount - The number of disputes that involve the requester as buyer or seller and match a given filter type.
Output property: ReturnedPaginationResult - The result of the pagination, including the total number of virtual pages in the result set and the total number of disputes returned.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetUserDisputesCall()
          Constructor.
GetUserDisputesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 DisputeFilterTypeCodeType getDisputeFilterType()
          Gets the GetUserDisputesRequestType.disputeFilterType.
 DisputeSortTypeCodeType getDisputeSortType()
          Gets the GetUserDisputesRequestType.disputeSortType.
 PaginationType getPagination()
          Gets the GetUserDisputesRequestType.pagination.
 DisputeArrayType getReturnedDisputeArray()
          Valid after executing the API.
 DisputeFilterCountType[] getReturnedDisputeFilterCount()
          Valid after executing the API.
 String getReturnedEndingDisputeID()
          Valid after executing the API.
 Integer getReturnedItemsPerPage()
          Valid after executing the API.
 Integer getReturnedPageNumber()
          Valid after executing the API.
 PaginationResultType getReturnedPaginationResult()
          Valid after executing the API.
 String getReturnedStartingDisputeID()
          Valid after executing the API.
 TimeFilter getTimeFilter()
          Gets the GetUserDisputesRequestType.timeFilter.
 GetUserDisputesResponseType getUserDisputes()
          Requests a list of disputes the requester is involved in as buyer or seller.
 void setDisputeFilterType(DisputeFilterTypeCodeType disputeFilterType)
          Sets the GetUserDisputesRequestType.disputeFilterType.
 void setDisputeSortType(DisputeSortTypeCodeType disputeSortType)
          Sets the GetUserDisputesRequestType.disputeSortType.
 void setPagination(PaginationType pagination)
          Sets the GetUserDisputesRequestType.pagination.
 void setTimeFilter(TimeFilter timeFilter)
          Sets the GetUserDisputesRequestType.timeFilter.
 
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

GetUserDisputesCall

public GetUserDisputesCall()
Constructor.


GetUserDisputesCall

public GetUserDisputesCall(ApiContext apiContext)
Constructor.

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

getUserDisputes

public GetUserDisputesResponseType getUserDisputes()
                                            throws ApiException,
                                                   SdkException,
                                                   Exception
Requests a list of disputes the requester is involved in as buyer or seller. eBay Money Back Guarantee Item Not Received and Return cases are not returned with this call. To retrieve eBay Money Back Guarantee cases, use the Search Cases call of the Post-Order API (or alternatively, the getUserCases call of the Resolution Case Management API.

Returns:
The GetUserDisputesResponseType object.
Throws:
ApiException
SdkException
Exception

getDisputeFilterType

public DisputeFilterTypeCodeType getDisputeFilterType()
Gets the GetUserDisputesRequestType.disputeFilterType.

Returns:
DisputeFilterTypeCodeType

setDisputeFilterType

public void setDisputeFilterType(DisputeFilterTypeCodeType disputeFilterType)
Sets the GetUserDisputesRequestType.disputeFilterType.

Parameters:
disputeFilterType - DisputeFilterTypeCodeType

getDisputeSortType

public DisputeSortTypeCodeType getDisputeSortType()
Gets the GetUserDisputesRequestType.disputeSortType.

Returns:
DisputeSortTypeCodeType

setDisputeSortType

public void setDisputeSortType(DisputeSortTypeCodeType disputeSortType)
Sets the GetUserDisputesRequestType.disputeSortType.

Parameters:
disputeSortType - DisputeSortTypeCodeType

getPagination

public PaginationType getPagination()
Gets the GetUserDisputesRequestType.pagination.

Returns:
PaginationType

setPagination

public void setPagination(PaginationType pagination)
Sets the GetUserDisputesRequestType.pagination.

Parameters:
pagination - PaginationType

getTimeFilter

public TimeFilter getTimeFilter()
Gets the GetUserDisputesRequestType.timeFilter.

Returns:
TimeFilter

setTimeFilter

public void setTimeFilter(TimeFilter timeFilter)
Sets the GetUserDisputesRequestType.timeFilter.

Parameters:
timeFilter - TimeFilter

getReturnedDisputeArray

public DisputeArrayType getReturnedDisputeArray()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedDisputeArray.

Returns:
DisputeArrayType

getReturnedDisputeFilterCount

public DisputeFilterCountType[] getReturnedDisputeFilterCount()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedDisputeFilterCount.

Returns:
DisputeFilterCountType[]

getReturnedEndingDisputeID

public String getReturnedEndingDisputeID()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedEndingDisputeID.

Returns:
String

getReturnedItemsPerPage

public Integer getReturnedItemsPerPage()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedItemsPerPage.

Returns:
Integer

getReturnedPageNumber

public Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedPageNumber.

Returns:
Integer

getReturnedPaginationResult

public PaginationResultType getReturnedPaginationResult()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedPaginationResult.

Returns:
PaginationResultType

getReturnedStartingDisputeID

public String getReturnedStartingDisputeID()
Valid after executing the API. Gets the returned GetUserDisputesResponseType.returnedStartingDisputeID.

Returns:
String

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.