eBay::API::XML::DataType::StoreCustomListingHeaderType - eBay::API::XML::DataType::StoreCustomListingHeaderType documentation

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

Index

Code Index:

NAME

Top

eBay::API::XML::DataType::StoreCustomListingHeaderType

DESCRIPTION

Top

Configuration of a Store custom listing header.

SYNOPSIS

Top

INHERITANCE

Top

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

Subroutines:

Top

setAddToFavoriteStores()

Specifies whether the custom header has a link to Add to Favorite Stores.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:boolean'

isAddToFavoriteStores()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:boolean'

setDisplayType()

Display type for the custom listing header.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'ns:StoreCustomListingHeaderDisplayCodeType'

getDisplayType()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'ns:StoreCustomListingHeaderDisplayCodeType'

setLinkToInclude()

Link to include in the custom header.

  Calls: SetStore
  RequiredInput: Conditionally

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

getLinkToInclude()

  Calls: GetStore
  Returned: Conditionally

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

Specifies whether the custom header has a logo.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:boolean'

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:boolean'

setSearchBox()

Specifies whether the custom header has a search box.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:boolean'

isSearchBox()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:boolean'

setSignUpForStoreNewsletter()

Specifies whether the custom header has a link to Sign up for Store Newsletter.

  Calls: SetStore
  RequiredInput: Conditionally

# Argument: 'xs:boolean'

isSignUpForStoreNewsletter()

  Calls: GetStore
  Returned: Conditionally

# Returns: 'xs:boolean'

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

package eBay::API::XML::DataType::StoreCustomListingHeaderType;

use strict;
use warnings;  

##########################################################################
#
# Module: ............... <user defined location>eBay/API/XML
# File: ................. StoreCustomListingHeaderType.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::StoreCustomListingHeaderLinkType;
use eBay::API::XML::DataType::Enum::StoreCustomListingHeaderDisplayCodeType;


my @gaProperties = ( [ 'AddToFavoriteStores', 'xs:boolean', '', '', '' ]
	, [ 'DisplayType', 'ns:StoreCustomListingHeaderDisplayCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::StoreCustomListingHeaderDisplayCodeType', '' ]
	, [ 'LinkToInclude', 'ns:StoreCustomListingHeaderLinkType', '1'
	     ,'eBay::API::XML::DataType::StoreCustomListingHeaderLinkType', '1' ]
	, [ 'Logo', 'xs:boolean', '', '', '' ]
	, [ 'SearchBox', 'xs:boolean', '', '', '' ]
	, [ 'SignUpForStoreNewsletter', 'xs:boolean', '', '', '' ]
                    );
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 setAddToFavoriteStores {
  my $self = shift;
  $self->{'AddToFavoriteStores'} = shift
}


sub isAddToFavoriteStores {
  my $self = shift;
  return $self->{'AddToFavoriteStores'};
}



sub setDisplayType {
  my $self = shift;
  $self->{'DisplayType'} = shift
}


sub getDisplayType {
  my $self = shift;
  return $self->{'DisplayType'};
}



sub setLinkToInclude {
  my $self = shift;
  $self->{'LinkToInclude'} = 
		$self->convertArray_To_RefToArrayIfNeeded(@_);
}


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



sub setLogo {
  my $self = shift;
  $self->{'Logo'} = shift
}


sub isLogo {
  my $self = shift;
  return $self->{'Logo'};
}



sub setSearchBox {
  my $self = shift;
  $self->{'SearchBox'} = shift
}


sub isSearchBox {
  my $self = shift;
  return $self->{'SearchBox'};
}



sub setSignUpForStoreNewsletter {
  my $self = shift;
  $self->{'SignUpForStoreNewsletter'} = shift
}


sub isSignUpForStoreNewsletter {
  my $self = shift;
  return $self->{'SignUpForStoreNewsletter'};
}





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

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



1;