Get NCIP configuration directory from the environment.
[working/NCIPServer.git] / lib / NCIP / Problem.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::Problem;
20 use parent qw(Class::Accessor);
21
22 =head1 NAME
23
24 Problem - Z39.83-1-2012
25
26 =head1 SYNOPSIS
27
28
29
30 =head1 DESCRIPTION
31
32 NCIP::Problem is the object used to report that a problem occurred
33 during message processing. Ext is avaialable for future use, but it is
34 not presently used by the problem template.  The obsolete
35 ProcessingError fields have been excluded.
36
37 =head1 FIELDS
38
39 =head2 ProblemType
40
41 Text string to identify the type of problem that occurred.
42
43 =head2 Scheme
44
45 URI to indicate the scheme from which the problem type originates. The
46 data dictionary indicates this field is required. The standard
47 elsewhere indicates that schemes are optional. Most examples from
48 vendors omit the scheme.
49
50 =head2 ProblemDetail
51
52 Text string describing the problem in detail.
53
54 =head2 ProblemElement
55
56 Text string to indicate the element that caused the problem. It may be
57 NULL to indicate no element.
58
59 =head2 ProblemValue
60
61 Text string to indicate the value in which the problem occurred.
62
63 =head2 Ext
64
65 Not presently used in the templates, but provided as a field defined
66 by the standard.
67
68 =cut
69
70 NCIP::Problem->mk_accessors(qw(ProblemType Scheme ProblemDetail ProblemElement
71                                ProblemValue Ext));
72
73 1;