com.ebay.sdk.call
Class AddDisputeCall

java.lang.Object
  com.ebay.sdk.ApiCall
      com.ebay.sdk.call.AddDisputeCall

public class AddDisputeCall
extends ApiCall

Wrapper class of the AddDispute call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2007

Company: eBay Inc.

Input property: DisputeExplanation - An explanation of the dispute that supplements the DisputeReason. The allowed value depends on the value of DisputeReason.
Input property: DisputeReason - The top-level reason for the Unpaid Item Dispute. DisputeReasonCodeType has several possible values. However, only BuyerHasNotPaid and TransactionMutuallyCanceled apply to AddDispute--you can only use AddDisputeCall to create Unpaid Item disputes.
Input property: ItemID - The eBay ID of the item in dispute, an item which has been sold but not yet paid for.
Input property: TransactionID - The eBay ID of a transaction, created when the buyer committed to purchasing the item. A transaction ID is unique to the item but not across the entire eBay site. The transaction ID must be combined with an item ID to uniquely identify an item.
Output property: ReturnedDisputeID - The unique identifier of the Unpaid Item dispute.

Field Summary

Fields inherited from class com.ebay.sdk.ApiCall

apiException, fullCredentials, sendReqListeners

Constructor Summary

AddDisputeCall()
Constructor.

AddDisputeCall(ApiContext apiContext)
Constructor.

Method Summary

DisputeIDType	addDispute() Enables a seller to create a new Unpaid Item dispute.
DisputeExplanationCodeType	getDisputeExplanation() Gets the AddDisputeRequestType.disputeExplanation.
DisputeReasonCodeType	getDisputeReason() Gets the AddDisputeRequestType.disputeReason.
ItemIDType	getItemID() Gets the AddDisputeRequestType.itemID.
DisputeIDType	getReturnedDisputeID() Valid after executing the API.
String	getTransactionID() Gets the AddDisputeRequestType.transactionID.
void	setDisputeExplanation(DisputeExplanationCodeType disputeExplanation) Sets the AddDisputeRequestType.disputeExplanation.
void	setDisputeReason(DisputeReasonCodeType disputeReason) Sets the AddDisputeRequestType.disputeReason.
void	setItemID(ItemIDType itemID) Sets the AddDisputeRequestType.itemID.
void	setTransactionID(String transactionID) Sets the AddDisputeRequestType.transactionID.

Methods inherited from class com.ebay.sdk.ApiCall

addDetailLevel, addSendRequestListener, execute, executeByApiName, getApiContext, getApiException, getCallRetry, getDetailLevel, getEnableCompression, getRequestXml, getResponseObject, getResponseXml, getSite, hasError, hasWarning, removeSendRequestListener, setApiContext, setCallRetry, setDetailLevel, setEnableCompression, setSite

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AddDisputeCall

public AddDisputeCall()

Constructor.

AddDisputeCall

public AddDisputeCall(ApiContext apiContext)

Constructor.

Parameters:

apiContext - The ApiContext object to be used to make the call.

Method Detail

addDispute

public DisputeIDType addDispute()
                         throws ApiException,
                                SdkException,
                                Exception

Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.)

Returns:

The DisputeIDType object.

Throws:

ApiException

SdkException

Exception

getDisputeExplanation

public DisputeExplanationCodeType getDisputeExplanation()

Gets the AddDisputeRequestType.disputeExplanation.

Returns:

DisputeExplanationCodeType

setDisputeExplanation

public void setDisputeExplanation(DisputeExplanationCodeType disputeExplanation)

Sets the AddDisputeRequestType.disputeExplanation.

Parameters:

disputeExplanation - DisputeExplanationCodeType

getDisputeReason

public DisputeReasonCodeType getDisputeReason()

Gets the AddDisputeRequestType.disputeReason.

Returns:

DisputeReasonCodeType

setDisputeReason

public void setDisputeReason(DisputeReasonCodeType disputeReason)

Sets the AddDisputeRequestType.disputeReason.

Parameters:

disputeReason - DisputeReasonCodeType

getItemID

public ItemIDType getItemID()

Gets the AddDisputeRequestType.itemID.

Returns:

ItemIDType

setItemID

public void setItemID(ItemIDType itemID)

Sets the AddDisputeRequestType.itemID.

Parameters:

itemID - ItemIDType

getTransactionID

public String getTransactionID()

Gets the AddDisputeRequestType.transactionID.

Returns:

String

setTransactionID

public void setTransactionID(String transactionID)

Sets the AddDisputeRequestType.transactionID.

Parameters:

transactionID - String

getReturnedDisputeID

public DisputeIDType getReturnedDisputeID()

Valid after executing the API. Gets the returned AddDisputeResponseType.returnedDisputeID.

Returns:

DisputeIDType