lib/NCIP/StructuredAddress.pm

   1 # ---------------------------------------------------------------
   2 # Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
   3 #
   4 # This file is part of NCIPServer.
   5 #
   6 # NCIPServer is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # NCIPServer is distributed in the hope that it will be useful, but
  12 # WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 # General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License
  17 # along with NCIPServer.  If not, see <http://www.gnu.org/licenses/>.
  18 # ---------------------------------------------------------------
  19 package NCIP::StructuredAddress;
  20 use parent qw(Class::Accessor);
  21
  22
  23 =head1 NAME
  24
  25 StructuredAddress - A "StructuredAddress" as defined by Z39.83-1-2012
  26
  27 =head1 SYNOPSIS
  28
  29
  30
  31 =head1 DESCRIPTION
  32
  33 This a "StructuredAddress" as defined by Z39.83-1-2012.  It is used
  34 for returning user address information when requested.  The fields
  35 are as defined in the standard.
  36
  37 =head1 FIELDS
  38
  39 =head2 Line1
  40
  41 First line of the address.
  42
  43 =head2 Line2
  44
  45 Second line of the address.
  46
  47 =head2 Locality
  48
  49 Locality of the address, typically a city.
  50
  51 =head2 Region
  52
  53 Region of the address, typically a state, province, or department.
  54
  55 =head2 PostalCode
  56
  57 The postal (or zip) code of the address.
  58
  59 =head2 Country
  60
  61 The country of the address.
  62
  63 =cut
  64
  65 NCIP::StructuredAddress->mk_accessors(qw(Line1 Line2 Locality Region PostalCode
  66                                          Country));
  67
  68 1;