eBay::API::XML::DataType::ResponseAttributeSetType(3)

NAME
eBay::API::XML::DataType::ResponseAttributeSetType

DESCRIPTION
A single set of one or more product families and related information returned in the results of a product search. Supports Pre-filled Item Information functionality. See the Developer's Guide for more information about working with this data.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::ResponseAttributeSetType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setApproximatePages()
As calculating the potentially large number of pages can affect this call's performance, and since the actual number of products returned per page can vary in each response, we cannot provide a precise total page count. Therefore, this is an estimated page count based on TotalProducts and other factors, such as the number of records eBay's search engine has examined so far in the product database. Once PageNumber approaches or exceeds this page count, we examine more records in the database and we may recalculate this value. If you estimate the number of pages yourself by using TotalProducts, EntriesPerPage, and MaxChildrenPerFamily (which is also an approximate value), your result will not necessarily match ApproximatePages.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPagination Title: Step4:Specify Pagination Properties

# Argument: 'xs:int'

  getApproximatePages()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always
  Max:
  Min: 1

# Returns: 'xs:int'

  setAttributeSetID()
Numeric value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristic set associated with the current set of search results. Always returned when AttributeSet is returned.

# Argument: 'xs:int'

  getAttributeSetID()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:int'

  setHasMore()
If true, the query results contain additional pages (higher than the current page number). You can retrieve more results by incrementing the PageNumber value that was passed in the request.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSRHasMore Title: Step6:Retrieve More Pages (If Necessary)

# Argument: 'xs:boolean'

  isHasMore()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:boolean'

  setProductFamilies()
ProductFamilies represents one product family. Multiple ProductFamilies properties can be returned. A product family identifies a group of related products. For example, the movie "My Favorite Movie: The Sequel" might be released on DVD, but there might be several editions of the DVD (e.g., in different languages) with different ISBN numbers. All variations are part of the same product family ("My Favorite Movie: The Sequel" in the DVD format). See "Limit the Quantity of Products Returned Per Family" in the eBay Web Services Guide. Always returned when AttributeSet is returned.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MaxChildrenPerFamily Title: Step2:Limit the Quantity of Products Returned Per Family

# Argument: reference to an array
                      of 'ns:ProductFamilyType'

  getProductFamilies()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: reference to an array
                      of 'ns:ProductFamilyType'

  setProductFinderConstraints()
A list of attributes (constraints) that were specified in the search request. This information is useful when multiple queries were specified in a GetProductSearchResults request. Use this information to map each query to each result in the response object. Applicable when the search request was constructed based on a product finder.

# Argument: reference to an array
                      of 'ns:ProductFinderConstraintType'

  getProductFinderConstraints()
  Calls: GetProductSearchResults
  Returned: Conditionally

# Returns: reference to an array
                      of 'ns:ProductFinderConstraintType'

  setTooManyMatchesFound()
If too many search results match the query, the TooManyMatchesFound tag is returned with a value of true, and a warning is returned. If this occurs, it may be a good idea to ask the user to specify more details to narrow the search (e.g., specify "My Favorite Movie" instead of "My"). Always returns false for GetProductFamilyMembers.

# Argument: 'xs:boolean'

  isTooManyMatchesFound()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:boolean'

  setTotalProducts()
The total quantity of products that match the query (within the characteristic set). This can exceed the actual number of products returned in the current virtual page. Always returned when AttributeSet is returned.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSRHasMore Title: Step6:Retrieve More Pages (If Necessary)

# Argument: 'xs:int'

  getTotalProducts()
  Calls: GetProductFamilyMembers
         GetProductSearchResults
  Returned: Always

# Returns: 'xs:int'