Changes since
the last release

com.ebay.sdk.call
Class GetVeROReportStatusCall

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

public class GetVeROReportStatusCall
extends ApiCall

Wrapper class of the GetVeROReportStatus 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: VeROReportPacketID - Packet identifier associated with the reported items for which you want to retrieve status. By default, reported item details are not returned when you specify the packet ID in the request. Applies only to items reported with the VeROReportItems call.
Input property: ItemID - Unique identifier for an eBay listing reported for alleged infringement. Applies to items reported with the VeROReportItems call or by other means (e.g., through the Web flow).
Input property: IncludeReportedItemDetails - Set to true to return reported item details when you specify VeROReportPacketID in the request.
Input property: TimeFrom - Limits returned items to only those that were submited on or after the date-time specified. If specified, TimeTo must also be specified. Express the date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) Applies to items reported with VeROReportItems or by other means (e.g., through the web flow). Infringement reporting data is maintained for two years after the date of submission. This field is ignored if VeROReportPacketID or ItemID is specified.
Input property: TimeTo - Limits returned items to only those that were submited on or before the date-time specified. If specified, TimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) Applies to items reported with VeROReportItems or by other means (e.g., through the web flow). Infringement reporting data is maintained for two years after the date of submission. This field is ignored if VeROReportPacketID or ItemID is specified.
Input property: Pagination - Contains the data controlling the pagination of the returned values: how many items are returned per page of data (per call) and the number of the page to return with the current call.
Output property: ReturnedPaginationResult - Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries.
Output property: ReturnedHasMoreItems - If true, there are more items yet to be retrieved. Additional calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request.
Output property: ReturnedItemsPerPage - Indicates the maximum number of Reported Item objects that can be returned in any given call.

Output property: ReturnedPageNumber - Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one.

Output property: ReturnedVeROReportPacketID - The packet ID for status being returned.
Output property: ReturnedVeROReportPacketStatus - Status of the packet.
Output property: ReturnedReportedItemDetails - This container of one or more reported items that match the input criteria in the call request. Returns empty if no items are available that match the request.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetVeROReportStatusCall()
          Constructor.
GetVeROReportStatusCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.Boolean getIncludeReportedItemDetails()
          Gets the GetVeROReportStatusRequestType.includeReportedItemDetails.
 java.lang.String getItemID()
          Gets the GetVeROReportStatusRequestType.itemID.
 PaginationType getPagination()
          Gets the GetVeROReportStatusRequestType.pagination.
 java.lang.Boolean getReturnedHasMoreItems()
          Valid after executing the API.
 java.lang.Integer getReturnedItemsPerPage()
          Valid after executing the API.
 java.lang.Integer getReturnedPageNumber()
          Valid after executing the API.
 PaginationResultType getReturnedPaginationResult()
          Valid after executing the API.
 VeROReportedItemDetailsType getReturnedReportedItemDetails()
          Valid after executing the API.
 java.lang.Long getReturnedVeROReportPacketID()
          Valid after executing the API.
 VeROReportPacketStatusCodeType getReturnedVeROReportPacketStatus()
          Valid after executing the API.
 java.util.Calendar getTimeFrom()
          Gets the GetVeROReportStatusRequestType.timeFrom.
 java.util.Calendar getTimeTo()
          Gets the GetVeROReportStatusRequestType.timeTo.
 java.lang.Long getVeROReportPacketID()
          Gets the GetVeROReportStatusRequestType.veROReportPacketID.
 PaginationResultType getVeROReportStatus()
          Retrieves status information about VeRO reported items you have submitted.
 void setIncludeReportedItemDetails(java.lang.Boolean includeReportedItemDetails)
          Sets the GetVeROReportStatusRequestType.includeReportedItemDetails.
 void setItemID(java.lang.String itemID)
          Sets the GetVeROReportStatusRequestType.itemID.
 void setPagination(PaginationType pagination)
          Sets the GetVeROReportStatusRequestType.pagination.
 void setTimeFrom(java.util.Calendar timeFrom)
          Sets the GetVeROReportStatusRequestType.timeFrom.
 void setTimeTo(java.util.Calendar timeTo)
          Sets the GetVeROReportStatusRequestType.timeTo.
 void setVeROReportPacketID(java.lang.Long veROReportPacketID)
          Sets the GetVeROReportStatusRequestType.veROReportPacketID.
 
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

GetVeROReportStatusCall

public GetVeROReportStatusCall()
Constructor.


GetVeROReportStatusCall

public GetVeROReportStatusCall(ApiContext apiContext)
Constructor.

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

getVeROReportStatus

public PaginationResultType getVeROReportStatus()
                                         throws ApiException,
                                                SdkException,
                                                java.lang.Exception
Retrieves status information about VeRO reported items you have submitted. You can receive the status of individual items you have reported or, by specifying VeROReportPacketID, you can retrieve status for all items reported with a given VeROReportItems request. You can also retrieve items that were reported during a given time period. If no input parameters are specified, status is returned on all items you have reported in the last two years. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

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

getIncludeReportedItemDetails

public java.lang.Boolean getIncludeReportedItemDetails()
Gets the GetVeROReportStatusRequestType.includeReportedItemDetails.

Returns:
Boolean

setIncludeReportedItemDetails

public void setIncludeReportedItemDetails(java.lang.Boolean includeReportedItemDetails)
Sets the GetVeROReportStatusRequestType.includeReportedItemDetails.

Parameters:
includeReportedItemDetails - Boolean

getItemID

public java.lang.String getItemID()
Gets the GetVeROReportStatusRequestType.itemID.

Returns:
String

setItemID

public void setItemID(java.lang.String itemID)
Sets the GetVeROReportStatusRequestType.itemID.

Parameters:
itemID - String

getPagination

public PaginationType getPagination()
Gets the GetVeROReportStatusRequestType.pagination.

Returns:
PaginationType

setPagination

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

Parameters:
pagination - PaginationType

getTimeFrom

public java.util.Calendar getTimeFrom()
Gets the GetVeROReportStatusRequestType.timeFrom.

Returns:
Calendar

setTimeFrom

public void setTimeFrom(java.util.Calendar timeFrom)
Sets the GetVeROReportStatusRequestType.timeFrom.

Parameters:
timeFrom - Calendar

getTimeTo

public java.util.Calendar getTimeTo()
Gets the GetVeROReportStatusRequestType.timeTo.

Returns:
Calendar

setTimeTo

public void setTimeTo(java.util.Calendar timeTo)
Sets the GetVeROReportStatusRequestType.timeTo.

Parameters:
timeTo - Calendar

getVeROReportPacketID

public java.lang.Long getVeROReportPacketID()
Gets the GetVeROReportStatusRequestType.veROReportPacketID.

Returns:
Long

setVeROReportPacketID

public void setVeROReportPacketID(java.lang.Long veROReportPacketID)
Sets the GetVeROReportStatusRequestType.veROReportPacketID.

Parameters:
veROReportPacketID - Long

getReturnedHasMoreItems

public java.lang.Boolean getReturnedHasMoreItems()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedHasMoreItems.

Returns:
Boolean

getReturnedItemsPerPage

public java.lang.Integer getReturnedItemsPerPage()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedItemsPerPage.

Returns:
Integer

getReturnedPageNumber

public java.lang.Integer getReturnedPageNumber()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedPageNumber.

Returns:
Integer

getReturnedPaginationResult

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

Returns:
PaginationResultType

getReturnedReportedItemDetails

public VeROReportedItemDetailsType getReturnedReportedItemDetails()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedReportedItemDetails.

Returns:
VeROReportedItemDetailsType

getReturnedVeROReportPacketID

public java.lang.Long getReturnedVeROReportPacketID()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedVeROReportPacketID.

Returns:
Long

getReturnedVeROReportPacketStatus

public VeROReportPacketStatusCodeType getReturnedVeROReportPacketStatus()
Valid after executing the API. Gets the returned GetVeROReportStatusResponseType.returnedVeROReportPacketStatus.

Returns:
VeROReportPacketStatusCodeType

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.