eBay::API::XML::Call::GetCategoryListings::GetCategoryListingsResponseType - eBay::API::XML::Call::GetCategoryListings::GetCategoryListingsResponseType documentation

eBay-API documentation Contained in the eBay-API distribution.

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetCategoryListings::GetCategoryListingsResponseType

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetCategoryListings::GetCategoryListingsResponseType inherits from the eBay::API::XML::ResponseDataType class

Subroutines:

Top

setBuyingGuideDetails()

Contains information about relevant buying guides (if any) and the site's buying guide hub. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them.

# Argument: 'ns:BuyingGuideDetailsType'

getBuyingGuideDetails()

  Returned: Conditionally
#    Returns: 'ns:BuyingGuideDetailsType'

setCategory()

Indicates the category from which the listings were drawn.

# Argument: 'ns:CategoryType'

getCategory()

  Returned: Always
#    Returns: 'ns:CategoryType'

setHasMoreItems()

Indicates whether there are more item listings that can be returned (items listed in the specified category and that meet any input filtering criteria).

# Argument: 'xs:boolean'

isHasMoreItems()

  Returned: Always
#    Returns: 'xs:boolean'

setItemArray()

Contains the item listings for the specified category and which meet the input filtering criteria (if any is specified). Consists of one ItemType object for each returned item listing.

# Argument: 'ns:ItemArrayType'

getItemArray()

  Returned: Conditionally
#    Returns: 'ns:ItemArrayType'

setItemsPerPage()

Indicates the maximum number of item listings that will be returned per call.

# Argument: 'xs:int'

getItemsPerPage()

  Returned: Always
#    Returns: 'xs:int'

setPageNumber()

Indicates the page of data returned in the current call.

# Argument: 'xs:int'

getPageNumber()

  Returned: Always
#    Returns: 'xs:int'

setPaginationResult()

Indicates the results of the pagination, including the total number of pages of data there are to be returned and the total number of items there are to be returned.

# Argument: 'ns:PaginationResultType'

getPaginationResult()

  Returned: Always
#    Returns: 'ns:PaginationResultType'

setRelatedSearchKeywordArray()

Container for keywords related to the category ID in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field.

# Argument: 'ns:RelatedSearchKeywordArrayType'

getRelatedSearchKeywordArray()

  Returned: Conditionally
#    Returns: 'ns:RelatedSearchKeywordArrayType'

setSubCategories()

Collection of the sub-categories that are child to the category indicated in Category. Data for each sub-category is conveyed in a CategoryType object.

# Argument: 'ns:CategoryArrayType'

getSubCategories()

  Returned: Conditionally
#    Returns: 'ns:CategoryArrayType'
eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::Call::GetCategoryListings::GetCategoryListingsResponseType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. GetCategoryListingsResponseType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################  


use eBay::API::XML::ResponseDataType;
our @ISA = ("eBay::API::XML::ResponseDataType");

use eBay::API::XML::DataType::BuyingGuideDetailsType;
use eBay::API::XML::DataType::CategoryArrayType;
use eBay::API::XML::DataType::CategoryType;
use eBay::API::XML::DataType::ItemArrayType;
use eBay::API::XML::DataType::PaginationResultType;
use eBay::API::XML::DataType::RelatedSearchKeywordArrayType;


my @gaProperties = ( [ 'BuyingGuideDetails', 'ns:BuyingGuideDetailsType', ''
	     ,'eBay::API::XML::DataType::BuyingGuideDetailsType', '1' ]
	, [ 'Category', 'ns:CategoryType', ''
	     ,'eBay::API::XML::DataType::CategoryType', '1' ]
	, [ 'HasMoreItems', 'xs:boolean', '', '', '' ]
	, [ 'ItemArray', 'ns:ItemArrayType', ''
	     ,'eBay::API::XML::DataType::ItemArrayType', '1' ]
	, [ 'ItemsPerPage', 'xs:int', '', '', '' ]
	, [ 'PageNumber', 'xs:int', '', '', '' ]
	, [ 'PaginationResult', 'ns:PaginationResultType', ''
	     ,'eBay::API::XML::DataType::PaginationResultType', '1' ]
	, [ 'RelatedSearchKeywordArray', 'ns:RelatedSearchKeywordArrayType', ''
	     ,'eBay::API::XML::DataType::RelatedSearchKeywordArrayType', '1' ]
	, [ 'SubCategories', 'ns:CategoryArrayType', ''
	     ,'eBay::API::XML::DataType::CategoryArrayType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::ResponseDataType::getPropertiesList()};

my @gaAttributes = ( 
                    );
push @gaAttributes, @{eBay::API::XML::ResponseDataType::getAttributesList()};


sub new {
  my $classname = shift;
  my %args = @_;
  my $self = $classname->SUPER::new(%args);
  return $self;
}

sub isScalar {
   return 0; 
}




sub setBuyingGuideDetails {
  my $self = shift;
  $self->{'BuyingGuideDetails'} = shift
}


sub getBuyingGuideDetails {
  my $self = shift;
  return $self->_getDataTypeInstance( 'BuyingGuideDetails'
		,'eBay::API::XML::DataType::BuyingGuideDetailsType');
}



sub setCategory {
  my $self = shift;
  $self->{'Category'} = shift
}


sub getCategory {
  my $self = shift;
  return $self->_getDataTypeInstance( 'Category'
		,'eBay::API::XML::DataType::CategoryType');
}



sub setHasMoreItems {
  my $self = shift;
  $self->{'HasMoreItems'} = shift
}


sub isHasMoreItems {
  my $self = shift;
  return $self->{'HasMoreItems'};
}



sub setItemArray {
  my $self = shift;
  $self->{'ItemArray'} = shift
}


sub getItemArray {
  my $self = shift;
  return $self->_getDataTypeInstance( 'ItemArray'
		,'eBay::API::XML::DataType::ItemArrayType');
}



sub setItemsPerPage {
  my $self = shift;
  $self->{'ItemsPerPage'} = shift
}


sub getItemsPerPage {
  my $self = shift;
  return $self->{'ItemsPerPage'};
}



sub setPageNumber {
  my $self = shift;
  $self->{'PageNumber'} = shift
}


sub getPageNumber {
  my $self = shift;
  return $self->{'PageNumber'};
}



sub setPaginationResult {
  my $self = shift;
  $self->{'PaginationResult'} = shift
}


sub getPaginationResult {
  my $self = shift;
  return $self->_getDataTypeInstance( 'PaginationResult'
		,'eBay::API::XML::DataType::PaginationResultType');
}



sub setRelatedSearchKeywordArray {
  my $self = shift;
  $self->{'RelatedSearchKeywordArray'} = shift
}


sub getRelatedSearchKeywordArray {
  my $self = shift;
  return $self->_getDataTypeInstance( 'RelatedSearchKeywordArray'
		,'eBay::API::XML::DataType::RelatedSearchKeywordArrayType');
}



sub setSubCategories {
  my $self = shift;
  $self->{'SubCategories'} = shift
}


sub getSubCategories {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SubCategories'
		,'eBay::API::XML::DataType::CategoryArrayType');
}





##  Attribute and Property lists
sub getPropertiesList {
   my $self = shift;
   return \@gaProperties;
}

sub getAttributesList {
   my $self = shift;
   return \@gaAttributes;
}



1;