lib/NCIP/User/OptionalFields.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::OptionalFields;
  20
  21 use parent qw(Class::Accessor);
  22
  23 =head1 NAME
  24
  25 OptionalFields - Data class for the UserOptionalFields
  26
  27 =head1 SYNOPSIS
  28
  29
  30
  31 =head1 DESCRIPTION
  32
  33 This data class holds the information for the UserOptionalFields. Most
  34 of the fields of this class all hold array refs of data objects as
  35 defined below. The one exception is NameInformation which only appears
  36 once.
  37
  38 All of the fields are optional.
  39
  40 =head1 FIELDS
  41
  42 =head2 NameInformation
  43
  44 This field holds the name information for the user. Currently, the
  45 templates ony support StructuredPersonalUserName.
  46
  47 =head2 UserAddressInformation
  48
  49 This is an array reference that contains
  50 NCIP::User::AddressInformation objects for the user's addresses. We
  51 currently only support StructuredAddress for physical addresses.
  52
  53 =head2 UserLanguage
  54
  55 A array of text strings indicating the user's languages.
  56
  57 =head2 BlockOrTrap
  58
  59 An array of NCIP::User::BlockOrTrap.
  60
  61 =head2 UserPrivilege
  62
  63 An array of NCIP::User::Privilege.
  64
  65 =head2 PreviousUserId
  66
  67 Not presently implemented.
  68
  69 =cut
  70
  71 NCIP::User::OptionalFields->mk_accessors(
  72     qw(
  73           NameInformation
  74           UserAddressInformation
  75           UserLanguage
  76           BlockOrTrap
  77           UserPrivilege
  78           PreviousUserId
  79       )
  80 );
  81
  82 1;