Changes since
the last release

com.ebay.sdk.call
Class GetDescriptionTemplatesCall

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

public class GetDescriptionTemplatesCall
extends ApiCall

Wrapper class of the GetDescriptionTemplates 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: CategoryID - A CategoryID value can be specified if the seller would like to only see the Listing Designer templates that are available for that eBay category. This field will be ignored if the MotorVehicles boolean field is also included in the call request and set to true.
Input property: LastModifiedTime - This dateTime filter can be included and used if the user only wants to check for recently-added Listing Designer templates. If this filter is used, only the Listing Designer templates that have been added/modified after the specified timestamp will be returned in the response.

Typically, you will pass in the timestamp value that was returned the last time you refreshed the list of Listing Designer templates.
Input property: MotorVehicles - This boolean field should be included and set to true if the user would only like to see the Listing Designer templates that are available for motor vehicle categories. This field will override any CategoryID value that is specified in the call request.
Output property: ReturnedDescriptionTemplate - A DescriptionTemplate container is retrieved for each available Listing Designer template. Each DescriptionTemplate container includes the unique identifier of the template, the Listing Designer Theme Group that it belongs to, the CDATA representation of the Listing Designer template, and the URL to an image that serves as an example of the Listing Designer template.
Output property: ReturnedLayoutTotal - This integer value indicates the total number of Listing Designer Layout templates that were retrieved. This field is always returned, even if it is 0
Output property: ReturnedObsoleteLayoutID - The unique identifier of a Listing Designer Layout template that is now obsolete. An ObsoleteLayoutID field is returned for each obsolete Listing Designer Layout template.
Output property: ReturnedObsoleteThemeID - The unique identifier of a Listing Designer Theme template that is now obsolete. An ObsoleteThemeID field is returned for each obsolete Listing Designer Theme template.
Output property: ReturnedThemeGroup - A ThemeGroup container is retrieved for each available Listing Designer Theme Group. Each ThemeGroup container includes the unique identifier of the Theme Group, the Theme Group name, and all of the Listing Designer Theme template that belong to that Theme Group.
Output property: ReturnedThemeTotal - This integer value indicates the total number of Listing Designer Theme templates that were retrieved. This field is always returned, even if it is 0

Version:
1.0
Author:
Ron Murphy

Field Summary
 
Fields inherited from class com.ebay.sdk.ApiCall
apiException, sendReqListeners
 
Constructor Summary
GetDescriptionTemplatesCall()
          Constructor.
GetDescriptionTemplatesCall(ApiContext apiContext)
          Constructor.
 
Method Summary
 java.lang.String getCategoryID()
          Gets the GetDescriptionTemplatesRequestType.categoryID.
 void getDescriptionTemplates()
          This is the base request type for the GetDescriptionTemplates call.
 java.util.Calendar getLastModifiedTime()
          Gets the GetDescriptionTemplatesRequestType.lastModifiedTime.
 java.lang.Boolean getMotorVehicles()
          Gets the GetDescriptionTemplatesRequestType.motorVehicles.
 DescriptionTemplateType[] getReturnedDescriptionTemplate()
          Valid after executing the API.
 int getReturnedLayoutTotal()
          Valid after executing the API.
 int[] getReturnedObsoleteLayoutID()
          Valid after executing the API.
 int[] getReturnedObsoleteThemeID()
          Valid after executing the API.
 ThemeGroupType[] getReturnedThemeGroup()
          Valid after executing the API.
 int getReturnedThemeTotal()
          Valid after executing the API.
 void setCategoryID(java.lang.String categoryID)
          Sets the GetDescriptionTemplatesRequestType.categoryID.
 void setLastModifiedTime(java.util.Calendar lastModifiedTime)
          Sets the GetDescriptionTemplatesRequestType.lastModifiedTime.
 void setMotorVehicles(java.lang.Boolean motorVehicles)
          Sets the GetDescriptionTemplatesRequestType.motorVehicles.
 
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

GetDescriptionTemplatesCall

public GetDescriptionTemplatesCall()
Constructor.


GetDescriptionTemplatesCall

public GetDescriptionTemplatesCall(ApiContext apiContext)
Constructor.

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

getDescriptionTemplates

public void getDescriptionTemplates()
                             throws ApiException,
                                    SdkException,
                                    java.lang.Exception
This is the base request type for the GetDescriptionTemplates call. This call retrieves detailed information on the Listing Designer templates that are available for use by the seller.

Throws:
ApiException
SdkException
java.lang.Exception

getCategoryID

public java.lang.String getCategoryID()
Gets the GetDescriptionTemplatesRequestType.categoryID.

Returns:
String

setCategoryID

public void setCategoryID(java.lang.String categoryID)
Sets the GetDescriptionTemplatesRequestType.categoryID.

Parameters:
categoryID - String

getLastModifiedTime

public java.util.Calendar getLastModifiedTime()
Gets the GetDescriptionTemplatesRequestType.lastModifiedTime.

Returns:
Calendar

setLastModifiedTime

public void setLastModifiedTime(java.util.Calendar lastModifiedTime)
Sets the GetDescriptionTemplatesRequestType.lastModifiedTime.

Parameters:
lastModifiedTime - Calendar

getMotorVehicles

public java.lang.Boolean getMotorVehicles()
Gets the GetDescriptionTemplatesRequestType.motorVehicles.

Returns:
Boolean

setMotorVehicles

public void setMotorVehicles(java.lang.Boolean motorVehicles)
Sets the GetDescriptionTemplatesRequestType.motorVehicles.

Parameters:
motorVehicles - Boolean

getReturnedDescriptionTemplate

public DescriptionTemplateType[] getReturnedDescriptionTemplate()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedDescriptionTemplate.

Returns:
DescriptionTemplateType[]

getReturnedLayoutTotal

public int getReturnedLayoutTotal()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedLayoutTotal.

Returns:
int

getReturnedObsoleteLayoutID

public int[] getReturnedObsoleteLayoutID()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedObsoleteLayoutID.

Returns:
int[]

getReturnedObsoleteThemeID

public int[] getReturnedObsoleteThemeID()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedObsoleteThemeID.

Returns:
int[]

getReturnedThemeGroup

public ThemeGroupType[] getReturnedThemeGroup()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedThemeGroup.

Returns:
ThemeGroupType[]

getReturnedThemeTotal

public int getReturnedThemeTotal()
Valid after executing the API. Gets the returned GetDescriptionTemplatesResponseType.returnedThemeTotal.

Returns:
int

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.