lib/NCIP/PhysicalAddress.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::PhysicalAddress;
  20 use parent qw(Class::Accessor);
  21
  22
  23 =head1 NAME
  24
  25 PhysicalAddress - A "PhysicalAddress" as defined by Z39.83-1-2012
  26
  27 =head1 SYNOPSIS
  28
  29
  30
  31 =head1 DESCRIPTION
  32
  33 This a "PhysicalAddress" 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 StructuredAddress
  40
  41 A NCIP::StructuredAddress object to hold the actual address.
  42
  43 =head2 UnstructuredAddress
  44
  45 Not presently implemented.
  46
  47 =head2 Type
  48
  49 The PhysicalAddressType field. Usually "Postal Address" or "Street Address."
  50
  51 =cut
  52
  53 NCIP::PhysicalAddress->mk_accessors(qw(StructuredAddress Type));
  54
  55 1;