lib/NCIP/User/AddressInformation.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::User::AddressInformation;
  20
  21 use parent qw(Class::Accessor);
  22
  23 =head1 NAME
  24
  25 AddressInformation - A user's Address Information
  26
  27 =head1 SYNOPSIS
  28
  29
  30
  31 =head1 DESCRIPTION
  32
  33 =head1 FIELDS
  34
  35 Either one of PhysicalAddress or ElectronicAddress must be defined,
  36 and they are mutually exclusive, i.e. if one has a value defined, the
  37 other must be undefined.
  38
  39 =head2 UserAddressRoleType
  40
  41 A text string to indicate the role of the address.
  42
  43 =head2 PhysicalAddress
  44
  45 A physical address stored in a NCIP::StructuredAddress.
  46
  47 =head2 ElectronicAddress
  48
  49 An electronic address or phone number stored in a
  50 NCIP::ElectronicAddress.
  51
  52 =cut
  53
  54 NCIP::User::AddressInformation->mk_accessors(
  55     qw(UserAddressRoleType PhysicalAddress ElectronicAddress)
  56 );
  57
  58 1;