lib/NCIP/Header.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::Header;
  20 use parent qw(Class::Accessor);
  21
  22 =head1 NAME
  23
  24 Header - Response Header as Defined in z39.83-1-2012
  25
  26 =head1 SYNOPSIS
  27
  28
  29
  30 =head1 DESCRIPTION
  31
  32 This is a NCIP ResponseHeader object.  We do not implement an
  33 initator, so we do not implement the InitiationHeader and we do not
  34 attempt to make this object generic enough to handle that field.
  35 The fields are as defined in Z39.83-1-2012.  Ext is provided but is
  36 not used by the current iteration of NCIPServer.
  37
  38 =head1 FIELDS
  39
  40 =head2 FromSystemId
  41
  42 Not used in the current implementation.
  43
  44 =head2 FromSystemAuthentication
  45
  46 Not used in the current implementation.
  47
  48 =head2 FromAgencyId
  49
  50 AgencyId of the agency sending the message.
  51
  52 =head2 FromAgencyAuthentication
  53
  54 Not used in the current implementation.
  55
  56 =head2 ToSystemId
  57
  58 Not used in the current implementation.
  59
  60 =head2 ToAgencyId
  61
  62 AgencyId of the agency receiving the message.
  63
  64 =head2 Ext
  65
  66 Not used in the current implementation.
  67
  68
  69 =cut
  70
  71 NCIP::Header->mk_accessors(qw(FromSystemId FromSystemAuthentication
  72                                FromAgencyId FromAgencyAuthentication
  73                                ToSystemId ToAgencyId Ext));
  74
  75 1;