NAME

eBay::API::XML::Call::GetUserDisputes::GetUserDisputesResponseType

DESCRIPTION

Returns a list of disputes that involve the calling user as buyer or seller, in response to a GetUserDisputesRequest.

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetUserDisputes::GetUserDisputesResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

setDisputeArray()

The array of disputes returned.

# Argument: 'ns:DisputeArrayType'

getDisputeArray()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: 'ns:DisputeArrayType'

setDisputeFilterCount()

The number of disputes that involve the requester as buyer or seller and match a given filter type.

# Argument: reference to an array of 'ns:DisputeFilterCountType'

getDisputeFilterCount()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: reference to an array  
                    of 'ns:DisputeFilterCountType'

setEndingDisputeID()

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.

# Argument: 'ns:DisputeIDType'

getEndingDisputeID()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: 'ns:DisputeIDType'

setItemsPerPage()

The number of disputes on each virtual page in the result set. The virtual page returned is determined by PageNumber. Default is 200.

# Argument: 'xs:int'

getItemsPerPage()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: 'xs:int'

setPageNumber()

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.

# Argument: 'xs:int'

getPageNumber()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: 'xs:int'

setPaginationResult()

The result of the pagination, including the total number of virtual pages in the result set and the total number of disputes returned.

# Argument: 'ns:PaginationResultType'

getPaginationResult()

Returned: Always
Details: DetailLevel: ReturnSummary, ReturnAll, none
#    Returns: 'ns:PaginationResultType'

setStartingDisputeID()

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.