NCIP::Item and friends.

[working/NCIPServer.git] / lib / NCIP / Item.pm

diff --git a/lib/NCIP/Item.pm b/lib/NCIP/Item.pm
index 93cfcaf..61ac61a 100644 (file)
--- a/lib/NCIP/Item.pm
+++ b/lib/NCIP/Item.pm
@@ -1,20 +1,109 @@
+# ---------------------------------------------------------------
+# Copyright © 2014 Jason J.A. Stephenson <jason@sigio.com>
+#
+# This file is part of NCIPServer.
+#
+# NCIPServer is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# NCIPServer is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with NCIPServer.  If not, see <http://www.gnu.org/licenses/>.
+# ---------------------------------------------------------------
 package NCIP::Item;
 
-use base qw(Class::Accessor);
+use parent qw(Class::Accessor);
 
-# Make accessors for the ones that makes sense
-NCIP::Item->mk_accessors(qw(itemid ils));
+=head1 NAME
 
-# Call the apppropriate subroutine in the ILS specific code and get the data
+Item - Defined as ItemInformation in z39.83-1-2012
 
-sub itemdata {
-    my $self = shift;
-    my $ils  = $self->ils;
-    my ( $itemdata, $error ) = $ils->itemdata( $self->itemid );
+=head1 SYNOPSIS
 
-# add anything NCIP specific not handled by the ILS to the itemdata object at this point, if no error
 
-    return $itemdata, $error;
-}
+
+=head1 DESCRIPTION
+
+=head1 FIELDS
+
+=head2 ItemId
+
+Optional NCIP::Item::Id object.
+
+=head2 RequestId
+
+Optional array of NCIP::RequestId objects.
+
+This field occurs only if Problem is not present in the same Item
+Information.
+
+=head2 CurrentBorrower
+
+Optional NCIP::User::Id object specifying the user to whom the item is
+currently charged.
+
+=head2 DateDue
+
+Optional date/time indicating the due date of the item.
+
+=head2 DateRecalled
+
+Optional date/time indicating the date and time of an item recall.
+
+=head2 HoldPickupDate
+
+Optional date/time indicating when a hold expires for the given item
+and user.
+
+=head2 ItemTransaction
+
+Not currently implemented.
+
+=head2 ItemOptionalFields
+
+Optional NCIP::Item::OptionalFields object.
+
+This field occurs only if Problem is not present in the same Item
+Information.
+
+=head2 ItemNote
+
+Text string that provides data additional to that provide in other
+data elements that comprise Item Information.
+
+Occurs 0 or 1 time but only if Problem is not present in the same Item
+Information.
+
+=head2 Problem
+
+Optional NCIP::Problem object to describe some problem with the item request.
+
+Occurs 0 or more times but only if Request Id, Current Borrower,
+Current Requester, Date Due, Date Recalled, Hold Pickup Date, Item
+Transaction, Item Optional Fields, and Item Note are not present in
+the same Item Information element.
+
+=cut
+
+NCIP::Item->mk_accessors(
+    qw(
+          ItemId
+          RequestId
+          CurrentBorrower
+          DateDue
+          DateRecalled
+          HoldPickupDate
+          ItemTransaction
+          ItemOptionalFields
+          ItemNote
+          Problem
+      )
+);
 
 1;