eBay::API::XML::DataType::ProductFamilyType - eBay::API::XML::DataType::ProductFamilyType documentation
Index
Code Index:
NAME
eBay::API::XML::DataType::ProductFamilyType
DESCRIPTION
A set of results returned from a catalog product search. Use
GetProductSearchResults or GetProductFamilyMembers to perform the search. See the
guide for information about Pre-filled Item Information (Catalogs) functionality.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::ProductFamilyType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setFamilyMembers()
A set of products (within the same product family) that match the search query.
# Argument: reference to an array
of 'ns:ProductType'
getFamilyMembers()
Calls: GetProductFamilyMembers
GetProductSearchResults
Returned: Always
# Returns: reference to an array
of 'ns:ProductType'
setParentProduct()
A transient header that describes the current search results. Contains a
an ID, a subset of attributes, and a typical stock photo
to help a user easily distinguish the products in the current result set
from products in other result sets returned in the same response.
One ParentProduct is returned per ProductFamily.
# Argument: 'ns:ProductType'
getParentProduct()
Calls: GetProductFamilyMembers
GetProductSearchResults
Returned: Always
# Returns: 'ns:ProductType'
setHasMoreChildren()
If true, the product family has more products than you requested in
MaxChildrenPerFamily for a query in the GetProductSearchResults request.
In this case, no products are returned in the GetProductSearchResults response.
(Call GetProductFamilyMembers to retrieve all products in the family.)
If false, the product family has MaxChildrenPerFamily or fewer product
children, and the call returns all products in the family.
# Argument: 'xs:boolean'
isHasMoreChildren()
Calls: GetProductFamilyMembers
GetProductSearchResults
Returned: Always
# Returns: 'xs:boolean'
#!/usr/bin/perl
package eBay::API::XML::DataType::ProductFamilyType;
use strict;
use warnings;
##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. ProductFamilyType.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::ProductType;
my @gaProperties = ( [ 'FamilyMembers', 'ns:ProductType', '1'
,'eBay::API::XML::DataType::ProductType', '1' ]
, [ 'ParentProduct', 'ns:ProductType', ''
,'eBay::API::XML::DataType::ProductType', '1' ]
);
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
my @gaAttributes = ( [ 'hasMoreChildren', 'xs:boolean', '', '', '' ]
);
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 setFamilyMembers {
my $self = shift;
$self->{'FamilyMembers'} =
$self->convertArray_To_RefToArrayIfNeeded(@_);
}
sub getFamilyMembers {
my $self = shift;
return $self->_getDataTypeArray('FamilyMembers');
}
sub setParentProduct {
my $self = shift;
$self->{'ParentProduct'} = shift
}
sub getParentProduct {
my $self = shift;
return $self->_getDataTypeInstance( 'ParentProduct'
,'eBay::API::XML::DataType::ProductType');
}
sub setHasMoreChildren {
my $self = shift;
$self->{'hasMoreChildren'} = shift
}
sub isHasMoreChildren {
my $self = shift;
return $self->{'hasMoreChildren'};
}
## Attribute and Property lists
sub getPropertiesList {
my $self = shift;
return \@gaProperties;
}
sub getAttributesList {
my $self = shift;
return \@gaAttributes;
}
1;