eBay::API::XML::Call::GetSuggestedCategories - eBay::API::XML::Call::GetSuggestedCategories documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::Call::GetSuggestedCategories

DESCRIPTION

Top

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::Call::GetSuggestedCategories inherits from the eBay::API::XML::BaseCall class

Subroutines:

Top

setQuery()

Specifies the search string, consisting of one or more words to search for in the listing title. The words "and" and "or" are treated like any other word.

MaxLength: 350 (characters)

  RequiredInput: Yes
#    Argument: 'xs:string'

getCategoryCount()

Indicates the number of categories in the array.

  Returned: Always
#    Returns: 'xs:int'

getSuggestedCategoryArray()

Contains the categories that contain listings that match the query string in the request. The array can have up to 10 categories. Not returned if no categories match the query in the request.

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

package eBay::API::XML::Call::GetSuggestedCategories;

use strict;
use warnings;  

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


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

use eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesRequestType;
use eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesResponseType;



sub getApiCallName {
   return 'GetSuggestedCategories';
}
sub getRequestDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesRequestType';
}
sub getResponseDataTypeFullPackage {
   return 'eBay::API::XML::Call::GetSuggestedCategories::GetSuggestedCategoriesResponseType';
}

#
# input properties
#


       
sub setQuery {
   my $self   = shift;
   my $sQuery = shift;
   $self->getRequestDataType()->setQuery($sQuery);
}



#
# output properties
#


       
sub getCategoryCount {
   my $self = shift;
   return $self->getResponseDataType()->getCategoryCount();
}


       
sub getSuggestedCategoryArray {
   my $self = shift;
   return $self->getResponseDataType()->getSuggestedCategoryArray();
}





1;