Changes since
the last release

com.ebay.sdk.call
Class GetAdFormatLeadsCall

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

public class GetAdFormatLeadsCall
extends ApiCall

Wrapper class of the GetAdFormatLeads 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: ItemID - The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. This ID must correspond to an ad format item.
Input property: Status - Filters the leads based on their status.
Input property: IncludeMemberMessages - Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.
Input property: StartCreationTime - Used with EndCreationTime to limit the returned leads for a user to only those with a creation date greater than or equal to the specified date and time.
Input property: EndCreationTime - Used with StartCreationTime to limit the returned leads for a user to only those with a creation date less than or equal to the specified date and time.
Output property: ReturnedAdFormatLeads - Contains contact and other information for one lead. One node is returned for each lead. Only returned at a detail level of ReturnAll. At least one lead must be available for the specified item to return AdFormatLead.
Output property: ReturnedAdFormatLeadCount - The total number of leads returned. Only returned if you do not specify a detail level.

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetAdFormatLeadsCall()
          Constructor.
GetAdFormatLeadsCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 void getAdFormatLeads()
          Retrieves sales lead information for a lead generation listing.
 java.util.Calendar getEndCreationTime()
          Gets the GetAdFormatLeadsRequestType.endCreationTime.
 java.lang.Boolean getIncludeMemberMessages()
          Gets the GetAdFormatLeadsRequestType.includeMemberMessages.
 java.lang.String getItemID()
          Gets the GetAdFormatLeadsRequestType.itemID.
 java.lang.Integer getReturnedAdFormatLeadCount()
          Valid after executing the API.
 AdFormatLeadType[] getReturnedAdFormatLeads()
          Valid after executing the API.
 java.util.Calendar getStartCreationTime()
          Gets the GetAdFormatLeadsRequestType.startCreationTime.
 MessageStatusTypeCodeType getStatus()
          Gets the GetAdFormatLeadsRequestType.status.
 void setEndCreationTime(java.util.Calendar endCreationTime)
          Sets the GetAdFormatLeadsRequestType.endCreationTime.
 void setIncludeMemberMessages(java.lang.Boolean includeMemberMessages)
          Sets the GetAdFormatLeadsRequestType.includeMemberMessages.
 void setItemID(java.lang.String itemID)
          Sets the GetAdFormatLeadsRequestType.itemID.
 void setStartCreationTime(java.util.Calendar startCreationTime)
          Sets the GetAdFormatLeadsRequestType.startCreationTime.
 void setStatus(MessageStatusTypeCodeType status)
          Sets the GetAdFormatLeadsRequestType.status.
 
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

GetAdFormatLeadsCall

public GetAdFormatLeadsCall()
Constructor.


GetAdFormatLeadsCall

public GetAdFormatLeadsCall(ApiContext apiContext)
Constructor.

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

getAdFormatLeads

public void getAdFormatLeads()
                      throws ApiException,
                             SdkException,
                             java.lang.Exception
Retrieves sales lead information for a lead generation listing.

Throws:
ApiException
SdkException
java.lang.Exception

getEndCreationTime

public java.util.Calendar getEndCreationTime()
Gets the GetAdFormatLeadsRequestType.endCreationTime.

Returns:
Calendar

setEndCreationTime

public void setEndCreationTime(java.util.Calendar endCreationTime)
Sets the GetAdFormatLeadsRequestType.endCreationTime.

Parameters:
endCreationTime - Calendar

getIncludeMemberMessages

public java.lang.Boolean getIncludeMemberMessages()
Gets the GetAdFormatLeadsRequestType.includeMemberMessages.

Returns:
Boolean

setIncludeMemberMessages

public void setIncludeMemberMessages(java.lang.Boolean includeMemberMessages)
Sets the GetAdFormatLeadsRequestType.includeMemberMessages.

Parameters:
includeMemberMessages - Boolean

getItemID

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

Returns:
String

setItemID

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

Parameters:
itemID - String

getStartCreationTime

public java.util.Calendar getStartCreationTime()
Gets the GetAdFormatLeadsRequestType.startCreationTime.

Returns:
Calendar

setStartCreationTime

public void setStartCreationTime(java.util.Calendar startCreationTime)
Sets the GetAdFormatLeadsRequestType.startCreationTime.

Parameters:
startCreationTime - Calendar

getStatus

public MessageStatusTypeCodeType getStatus()
Gets the GetAdFormatLeadsRequestType.status.

Returns:
MessageStatusTypeCodeType

setStatus

public void setStatus(MessageStatusTypeCodeType status)
Sets the GetAdFormatLeadsRequestType.status.

Parameters:
status - MessageStatusTypeCodeType

getReturnedAdFormatLeadCount

public java.lang.Integer getReturnedAdFormatLeadCount()
Valid after executing the API. Gets the returned GetAdFormatLeadsResponseType.returnedAdFormatLeadCount.

Returns:
Integer

getReturnedAdFormatLeads

public AdFormatLeadType[] getReturnedAdFormatLeads()
Valid after executing the API. Gets the returned GetAdFormatLeadsResponseType.returnedAdFormatLeads.

Returns:
AdFormatLeadType[]

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.