lib/NCIP/StructuredPersonalUserName.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::StructuredPersonalUserName;
  20
  21 use parent qw(Class::Accessor);
  22
  23 # The name of this class is a bit unwieldy, but comes directly from
  24 # the standard.  I wonder if we shouldn't rename for our own sanity.
  25
  26 =head1 NAME
  27
  28 StructuredPersonalUserName - Object to hold name information
  29
  30 =head1 SYNOPSIS
  31
  32
  33
  34 =head1 DESCRIPTION
  35
  36 =head1 FIELDS
  37
  38 The fields are text strings.
  39
  40 =head2 Prefix
  41
  42 Optional field to hold the user's name prefix.
  43
  44 =head2 GivenName
  45
  46 Optional field to hold the user's given, or first, name.
  47
  48 =head2 Surname
  49
  50 Required field to hold the user's surname. This is the user's family
  51 name.
  52
  53 This field is required by the standard and also so the code may tell
  54 the difference from an unstructured name if we ever support it.
  55
  56 =head2 Initials
  57
  58 Optional field for the user's name initials.
  59
  60 =head2 Suffix
  61
  62 Optional field for the user's name suffix, if any.
  63
  64 =cut
  65
  66 NCIP::StructuredPersonalUserName->mk_accessors(
  67     qw(Prefix GivenName Surname Initials Suffix)
  68 );
  69
  70 1;