File Coverage

lib/eBay/API/XML/DataType/SiteDetailsType.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


line stmt bran cond sub pod time code
1             #!/usr/bin/perl
2              
3             package eBay::API::XML::DataType::SiteDetailsType;
4              
5 1     1   1578 use strict;
  1         2  
  1         37  
6 1     1   4 use warnings;
  1         2  
  1         32  
7              
8             ##########################################################################
9             #
10             # Module: ............... eBay/API/XML
11             # File: ................. SiteDetailsType.pm
12             # Generated by: ......... genEBayApiDataTypes.pl
13             # Last Generated: ....... 08/24/2008 16:44
14             # API Release Number: ... 579
15             #
16             ##########################################################################
17              
18             =head1 NAME
19              
20             eBay::API::XML::DataType::SiteDetailsType
21              
22             =head1 DESCRIPTION
23              
24             Details about a specific site.
25              
26              
27              
28             =head1 SYNOPSIS
29              
30             =cut
31              
32              
33             =head1 INHERITANCE
34              
35             eBay::API::XML::DataType::SiteDetailsType inherits from the L class
36              
37             =cut
38              
39 1     1   43 use eBay::API::XML::BaseDataType;
  0            
  0            
40             our @ISA = ("eBay::API::XML::BaseDataType");
41              
42             use eBay::API::XML::DataType::Enum::SiteCodeType;
43              
44              
45             my @gaProperties = ( [ 'Site', 'ns:SiteCodeType', ''
46             ,'eBay::API::XML::DataType::Enum::SiteCodeType', '' ]
47             , [ 'SiteID', 'xs:int', '', '', '' ]
48             );
49             push @gaProperties, @{eBay::API::XML::BaseDataType::getPropertiesList()};
50              
51             my @gaAttributes = (
52             );
53             push @gaAttributes, @{eBay::API::XML::BaseDataType::getAttributesList()};
54              
55             =head1 Subroutines:
56              
57             =cut
58              
59             sub new {
60             my $classname = shift;
61             my %args = @_;
62             my $self = $classname->SUPER::new(%args);
63             return $self;
64             }
65              
66             sub isScalar {
67             return 0;
68             }
69              
70              
71              
72             =head2 setSite()
73              
74             Short name that identifies an eBay site. Usually, an eBay site is associated
75             with a particular country or region (e.g., US or Belgium_French).
76             Specialty sites (e.g., eBay Express or eBay Stores) use the same site ID as
77             their associated main eBay site. The US eBay Motors site is an exception to this convention.

78             Related fields:
79             Item.Site in AddItem
80             User.Site in GetUser
81              
82             # Argument: 'ns:SiteCodeType'
83              
84             =cut
85              
86             sub setSite {
87             my $self = shift;
88             $self->{'Site'} = shift
89             }
90              
91             =head2 getSite()
92              
93             Calls: GeteBayDetails
94             Returned: Conditionally
95              
96             # Returns: 'ns:SiteCodeType'
97              
98             =cut
99              
100             sub getSite {
101             my $self = shift;
102             return $self->{'Site'};
103             }
104              
105              
106             =head2 setSiteID()
107              
108             Numeric identifier for an eBay site. If you are using the
109             SOAP API, you use numeric site IDs in the request URL.
110             If you are using the XML API, you use numeric site IDs in the
111             X-EBAY-API-SITEID header.
112              
113             # Argument: 'xs:int'
114              
115             =cut
116              
117             sub setSiteID {
118             my $self = shift;
119             $self->{'SiteID'} = shift
120             }
121              
122             =head2 getSiteID()
123              
124             Calls: GeteBayDetails
125             Returned: Conditionally
126              
127             # Returns: 'xs:int'
128              
129             =cut
130              
131             sub getSiteID {
132             my $self = shift;
133             return $self->{'SiteID'};
134             }
135              
136              
137              
138              
139              
140             ## Attribute and Property lists
141             sub getPropertiesList {
142             my $self = shift;
143             return \@gaProperties;
144             }
145              
146             sub getAttributesList {
147             my $self = shift;
148             return \@gaAttributes;
149             }
150              
151              
152              
153             1;