|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetDescriptionTemplatesCall
public class GetDescriptionTemplatesCall
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.
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
.
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.
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.
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.
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
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.
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.
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.
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
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetDescriptionTemplatesCall()
public GetDescriptionTemplatesCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public void getDescriptionTemplates() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.String getCategoryID()
public void setCategoryID(java.lang.String categoryID)
categoryID
- Stringpublic java.util.Calendar getLastModifiedTime()
public void setLastModifiedTime(java.util.Calendar lastModifiedTime)
lastModifiedTime
- Calendarpublic java.lang.Boolean getMotorVehicles()
public void setMotorVehicles(java.lang.Boolean motorVehicles)
motorVehicles
- Booleanpublic DescriptionTemplateType[] getReturnedDescriptionTemplate()
public int getReturnedLayoutTotal()
public int[] getReturnedObsoleteLayoutID()
public int[] getReturnedObsoleteThemeID()
public ThemeGroupType[] getReturnedThemeGroup()
public int getReturnedThemeTotal()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.