eBay::API::XML::DataType::SellerFavoriteItemPreferencesType - eBay::API::XML::DataType::SellerFavoriteItemPreferencesType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::SellerFavoriteItemPreferencesType

DESCRIPTION

Top

Contains the data for the seller favorite item preferences, i.e. the manual or automatic selection criteria to display items for buyer's favourite seller opt in email marketing.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setFavoriteItemID()

Specifies the list of favorite items.

  Calls: SetUserPreferences
  RequiredInput: No

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

getFavoriteItemID()

  Calls: GetUserPreferences
  Returned: Conditionally

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

setListingType()

The listing format (fixed price, auction, etc) for the automatic item search criteria.

  Calls: SetUserPreferences
  RequiredInput: No
  OnlyTheseValues: Auction, StoresFixedPrice, LeadGeneration,
							FixedPriceItem

# Argument: 'ns:ListingTypeCodeType'

getListingType()

  Calls: GetUserPreferences
  Returned: Conditionally
  OnlyTheseValues: Auction, StoresFixedPrice, LeadGeneration,
							FixedPriceItem

# Returns: 'ns:ListingTypeCodeType'

setMaxPrice()

Specifies the upper limit of price range for the automatic search criteria.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'ns:AmountType'

getMaxPrice()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'ns:AmountType'

setMinPrice()

Specifies the lower limit of price range for the automatic search criteria.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'ns:AmountType'

getMinPrice()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'ns:AmountType'

setSearchKeywords()

The keywords in the item title for the automatic item search criteria.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:string'

getSearchKeywords()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:string'

setSearchSortOrder()

The sort order chosen from the standard ebay sorts for the automatic search criteria.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'ns:StoreItemListSortOrderCodeType'

getSearchSortOrder()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'ns:StoreItemListSortOrderCodeType'

setStoreCategoryID()

(For eBay Store owners only) The store custom category for the automatic item search criteria.

  Calls: SetUserPreferences
  RequiredInput: No

# Argument: 'xs:long'

getStoreCategoryID()

  Calls: GetUserPreferences
  Returned: Conditionally

# Returns: 'xs:long'

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

package eBay::API::XML::DataType::SellerFavoriteItemPreferencesType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. SellerFavoriteItemPreferencesType.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::AmountType;
use eBay::API::XML::DataType::ItemIDType;
use eBay::API::XML::DataType::Enum::ListingTypeCodeType;
use eBay::API::XML::DataType::Enum::StoreItemListSortOrderCodeType;


my @gaProperties = ( [ 'FavoriteItemID', 'ns:ItemIDType', '1'
	     ,'eBay::API::XML::DataType::ItemIDType', '1' ]
	, [ 'ListingType', 'ns:ListingTypeCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::ListingTypeCodeType', '' ]
	, [ 'MaxPrice', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'MinPrice', 'ns:AmountType', ''
	     ,'eBay::API::XML::DataType::AmountType', '1' ]
	, [ 'SearchKeywords', 'xs:string', '', '', '' ]
	, [ 'SearchSortOrder', 'ns:StoreItemListSortOrderCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreItemListSortOrderCodeType', '' ]
	, [ 'StoreCategoryID', 'xs:long', '', '', '' ]
                    );
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 setFavoriteItemID {
  my $self = shift;
  $self->{'FavoriteItemID'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


sub getFavoriteItemID {
  my $self = shift;
  return $self->_getDataTypeArray('FavoriteItemID');
}



sub setListingType {
  my $self = shift;
  $self->{'ListingType'} = shift
}


sub getListingType {
  my $self = shift;
  return $self->{'ListingType'};
}



sub setMaxPrice {
  my $self = shift;
  $self->{'MaxPrice'} = shift
}


sub getMaxPrice {
  my $self = shift;
  return $self->_getDataTypeInstance( 'MaxPrice'
		,'eBay::API::XML::DataType::AmountType');
}



sub setMinPrice {
  my $self = shift;
  $self->{'MinPrice'} = shift
}


sub getMinPrice {
  my $self = shift;
  return $self->_getDataTypeInstance( 'MinPrice'
		,'eBay::API::XML::DataType::AmountType');
}



sub setSearchKeywords {
  my $self = shift;
  $self->{'SearchKeywords'} = shift
}


sub getSearchKeywords {
  my $self = shift;
  return $self->{'SearchKeywords'};
}



sub setSearchSortOrder {
  my $self = shift;
  $self->{'SearchSortOrder'} = shift
}


sub getSearchSortOrder {
  my $self = shift;
  return $self->{'SearchSortOrder'};
}



sub setStoreCategoryID {
  my $self = shift;
  $self->{'StoreCategoryID'} = shift
}


sub getStoreCategoryID {
  my $self = shift;
  return $self->{'StoreCategoryID'};
}





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

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



1;