|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetUserDisputesCall
public class GetUserDisputesCall
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.
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.
DisputeSortType
- The value and sequence to use to sort the returned disputes.
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.
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.
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.
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.
ReturnedDisputeArray
- The array of disputes returned.
ReturnedItemsPerPage
- The number of disputes on each virtual page in the result set.
The virtual page returned is determined by PageNumber.
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.
ReturnedDisputeFilterCount
- The number of disputes that involve the requester as
buyer or seller and match a given filter type.
ReturnedPaginationResult
- The result of the pagination, including the total number
of virtual pages in the result set and the total number of
disputes returned.
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetUserDisputesCall()
public GetUserDisputesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public GetUserDisputesResponseType getUserDisputes() throws ApiException, SdkException, Exception
ApiException
SdkException
Exception
public DisputeFilterTypeCodeType getDisputeFilterType()
public void setDisputeFilterType(DisputeFilterTypeCodeType disputeFilterType)
disputeFilterType
- DisputeFilterTypeCodeTypepublic DisputeSortTypeCodeType getDisputeSortType()
public void setDisputeSortType(DisputeSortTypeCodeType disputeSortType)
disputeSortType
- DisputeSortTypeCodeTypepublic PaginationType getPagination()
public void setPagination(PaginationType pagination)
pagination
- PaginationTypepublic TimeFilter getTimeFilter()
public void setTimeFilter(TimeFilter timeFilter)
timeFilter
- TimeFilterpublic DisputeArrayType getReturnedDisputeArray()
public DisputeFilterCountType[] getReturnedDisputeFilterCount()
public String getReturnedEndingDisputeID()
public Integer getReturnedItemsPerPage()
public Integer getReturnedPageNumber()
public PaginationResultType getReturnedPaginationResult()
public String getReturnedStartingDisputeID()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.