From 36a7baf4ddca8a4e477d9363d1bb7ecf7a964764 Mon Sep 17 00:00:00 2001 From: Jason Stephenson Date: Sun, 17 Aug 2014 20:55:17 -0400 Subject: [PATCH] Add POD to lib/NCIP/Problem.pm. Signed-off-by: Jason Stephenson --- lib/NCIP/Problem.pm | 52 ++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 47 insertions(+), 5 deletions(-) diff --git a/lib/NCIP/Problem.pm b/lib/NCIP/Problem.pm index fc8fa06..e310623 100644 --- a/lib/NCIP/Problem.pm +++ b/lib/NCIP/Problem.pm @@ -19,11 +19,53 @@ package NCIP::Problem; use parent qw(Class::Accessor); -# NCIP::Problem is the object used to report that a problem occurred -# during message processing. The fields are as defined in -# Z39.83-1-2012. Ext is avaialable for future use, but it is not -# presently used by the problem template. The obsolete -# ProcessingError fields have been excluded. +=head1 NAME + +Problem - Z39.83-1-2012 + +=head1 SYNOPSIS + + + +=head1 DESCRIPTION + +NCIP::Problem is the object used to report that a problem occurred +during message processing. Ext is avaialable for future use, but it is +not presently used by the problem template. The obsolete +ProcessingError fields have been excluded. + +=head1 FIELDS + +=head2 ProblemType + +Text string to identify the type of problem that occurred. + +=head2 Scheme + +URI to indicate the scheme from which the problem type originates. The +data dictionary indicates this field is required. The standard +elsewhere indicates that schemes are optional. Most examples from +vendors omit the scheme. + +=head2 ProblemDetail + +Text string describing the problem in detail. + +=head2 ProblemElement + +Text string to indicate the element that caused the problem. It may be +NULL to indicate no element. + +=head2 ProblemValue + +Text string to indicate the value in which the problem occurred. + +=head2 Ext + +Not presently used in the templates, but provided as a field defined +by the standard. + +=cut NCIP::Problem->mk_accessors(qw(ProblemType Scheme ProblemDetail ProblemElement ProblemValue Ext)); -- 2.43.2