File Coverage

lib/eBay/API/XML/DataType/FlatShippingDiscountType.pm

Criterion	Covered	Total	%
statement	7	9	77.7
branch			n/a
condition			n/a
subroutine	3	3	100.0
pod			n/a
total	10	12	83.3

#!/usr/bin/perl

package eBay::API::XML::DataType::FlatShippingDiscountType;

use strict;
use warnings;

##########################################################################
#
# Module: ............... eBay/API/XML
# File: ................. FlatShippingDiscountType.pm
# Generated by: ......... genEBayApiDataTypes.pl
# Last Generated: ....... 08/24/2008 16:44
# API Release Number: ... 579
#
##########################################################################

=head1 NAME

eBay::API::XML::DataType::FlatShippingDiscountType

=head1 DESCRIPTION

Details of an individual discount profile defined by the
user for flat rate shipping.



=head1 SYNOPSIS

=cut


=head1 INHERITANCE

eBay::API::XML::DataType::FlatShippingDiscountType inherits from the L class

=cut

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

use eBay::API::XML::DataType::DiscountProfileType;
use eBay::API::XML::DataType::Enum::DiscountNameCodeType;


my @gaProperties = ( [ 'DiscountName', 'ns:DiscountNameCodeType', ''
	     ,'eBay::API::XML::DataType::Enum::DiscountNameCodeType', '' ]
	, [ 'DiscountProfile', 'ns:DiscountProfileType', '1'
	     ,'eBay::API::XML::DataType::DiscountProfileType', '1' ]
                    );
push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};

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

=head1 Subroutines:

=cut

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

sub isScalar {
   return 0;
}



=head2 setDiscountName()

The type of discount or "rule" that is being used by the profile.
The value corresponding to the selected rule is set in the same-named field
of FlatShippingDiscount.DiscountProfile. All are "variable" rules, as
defined in the documentation on shipping discount profiles.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles
Title: Shipping Cost Discount Profiles

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally
  OnlyTheseValues:
								EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff


#    Argument: 'ns:DiscountNameCodeType'

=cut

sub setDiscountName {
  my $self = shift;
  $self->{'DiscountName'} = shift
}

=head2 getDiscountName()

  Calls: GetShippingDiscountProfiles
  Returned: Conditionally
  OnlyTheseValues:
								EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff


  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
  OnlyTheseValues:
								EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff


#    Returns: 'ns:DiscountNameCodeType'

=cut

sub getDiscountName {
  my $self = shift;
  return $self->{'DiscountName'};
}


=head2 setDiscountProfile()

Details of this particular flat rate shipping discount profile. If
ModifyActionCode is Modify, all details of the new version of the profile must
be provided. If ModifyActionCode is Delete, DiscountProfileID is required,
MappingDiscountProfileID is optional, and all other fields of DiscountProfile
are ignored. Restrictions of how many profiles you can have for a given
discount rule are discussed in the documentation on shipping discount
profiles.

SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles
Title: Shipping Cost Discount Profiles

  Calls: SetShippingDiscountProfiles
  RequiredInput: Conditionally
  OnlyTheseValues:
								EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff


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

=cut

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

=head2 getDiscountProfile()

  Calls: GetShippingDiscountProfiles
  Returned: Conditionally

  Calls: GetItem
  Returned: Conditionally
  Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

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

=cut

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





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

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



1;