eBay::API::XML::DataType::SearchLocationType - eBay::API::XML::DataType::SearchLocationType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::SearchLocationType

DESCRIPTION

Top

One of the data filters used when searching for items using GetSearchResults or GetCategoryListings. Allows filtering based on the location of the item or its availability relative to an eBay site. Or allows for filtering based on regional listing.

SYNOPSIS

Top

INHERITANCE

Top

eBay::API::XML::DataType::SearchLocationType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

Top

setRegionID()

Specifies a region ID. The item must have been listed for the specified region to be returned in the search result set.

  Calls: GetSearchResults
         GetCategoryListings
  RequiredInput: No

# Argument: 'xs:string'

getRegionID()

# Returns: 'xs:string'

setSiteLocation()

Specifies a filter based on a particular eBay site and the item's relation to that site (items listed with a site's currency, items located in the country for the site, items available to the country for the site, and items listed on the specified site).

  Calls: GetSearchResults
         GetCategoryListings
  RequiredInput: No

# Argument: 'ns:SiteLocationType'

getSiteLocation()

# Returns: 'ns:SiteLocationType'

eBay-API documentation Contained in the eBay-API distribution. 
#!/usr/bin/perl

package eBay::API::XML::DataType::SearchLocationType;

use strict;
use warnings;  

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


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

use eBay::API::XML::DataType::SiteLocationType;


my @gaProperties = ( [ 'RegionID', 'xs:string', '', '', '' ]
	, [ 'SiteLocation', 'ns:SiteLocationType', ''
	     ,'eBay::API::XML::DataType::SiteLocationType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

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


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

sub isScalar {
   return 0; 
}




sub setRegionID {
  my $self = shift;
  $self->{'RegionID'} = shift
}


sub getRegionID {
  my $self = shift;
  return $self->{'RegionID'};
}



sub setSiteLocation {
  my $self = shift;
  $self->{'SiteLocation'} = shift
}


sub getSiteLocation {
  my $self = shift;
  return $self->_getDataTypeInstance( 'SiteLocation'
		,'eBay::API::XML::DataType::SiteLocationType');
}





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

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



1;