Changes since
the last release

com.ebay.sdk.call
Class GetVeROReasonCodeDetailsCall

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

public class GetVeROReasonCodeDetailsCall
extends ApiCall

Wrapper class of the GetVeROReasonCodeDetails 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: ReasonCodeID - Unique identifier for a reason code. If this ReasonCodeID field is passed in, only the details related to this ReasonCodeID will be returned. If no reason code is specified, all reason codes are returned.
Input property: ReturnAllSites - Set to true to retrieve reason codes for all sites. If not specified, reason codes are returned for the site specified in the request header only. If a ReasonCodeID value is specified, this parameter is ignored.
Output property: ReturnedVeROReasonCodeDetails - This container consists of one or more VeRO Program copyright/intellectual property infringement violation types for one or more eBay sites.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetVeROReasonCodeDetailsCall()
          Constructor.
GetVeROReasonCodeDetailsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Long getReasonCodeID()
          Gets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.
 java.lang.Boolean getReturnAllSites()
          Gets the GetVeROReasonCodeDetailsRequestType.returnAllSites.
 VeROReasonCodeDetailsType getReturnedVeROReasonCodeDetails()
          Valid after executing the API.
 VeROReasonCodeDetailsType getVeROReasonCodeDetails()
          Retrieves details for VeRO reason codes and their descriptions.
 void setReasonCodeID(java.lang.Long reasonCodeID)
          Sets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.
 void setReturnAllSites(java.lang.Boolean returnAllSites)
          Sets the GetVeROReasonCodeDetailsRequestType.returnAllSites.
 
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, isEnableoAuthTokenHTTPHeader, removeSendRequestListener, setApiContext, setBotBlock, setCallRetry, setDetailLevel, setEnableCompression, setEnableoAuthTokenHTTPHeader, 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

GetVeROReasonCodeDetailsCall

public GetVeROReasonCodeDetailsCall()
Constructor.


GetVeROReasonCodeDetailsCall

public GetVeROReasonCodeDetailsCall(ApiContext apiContext)
Constructor.

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

getVeROReasonCodeDetails

public VeROReasonCodeDetailsType getVeROReasonCodeDetails()
                                                   throws ApiException,
                                                          SdkException,
                                                          java.lang.Exception
Retrieves details for VeRO reason codes and their descriptions. You can specify a reason code ID to get details for a specific reason on the site specified in the request header. If ReasonCodeID is not passed in the request, all reason codes are returned. Set ReturnAllSites to true to retrieve reason codes for all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Returns:
The VeROReasonCodeDetailsType object.
Throws:
ApiException
SdkException
java.lang.Exception

getReasonCodeID

public java.lang.Long getReasonCodeID()
Gets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.

Returns:
Long

setReasonCodeID

public void setReasonCodeID(java.lang.Long reasonCodeID)
Sets the GetVeROReasonCodeDetailsRequestType.reasonCodeID.

Parameters:
reasonCodeID - Long

getReturnAllSites

public java.lang.Boolean getReturnAllSites()
Gets the GetVeROReasonCodeDetailsRequestType.returnAllSites.

Returns:
Boolean

setReturnAllSites

public void setReturnAllSites(java.lang.Boolean returnAllSites)
Sets the GetVeROReasonCodeDetailsRequestType.returnAllSites.

Parameters:
returnAllSites - Boolean

getReturnedVeROReasonCodeDetails

public VeROReasonCodeDetailsType getReturnedVeROReasonCodeDetails()
Valid after executing the API. Gets the returned GetVeROReasonCodeDetailsResponseType.returnedVeROReasonCodeDetails.

Returns:
VeROReasonCodeDetailsType

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.