NCIP::Item and friends.
[working/NCIPServer.git] / lib / NCIP / Item / 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::Item::OptionalFields;
20
21 use parent qw(Class::Accessor);
22
23 =head1 NAME
24
25 OptionalFields - As defined in z39.83-1-2012
26
27 =head1 SYNOPSIS
28
29
30
31 =head1 DESCRIPTION
32
33 =head1 FIELDS
34
35 =head2 BibliographicDescription
36
37 Optional NCIP::Item::BibliographicDescription object.
38
39 =head2 ItemUseRestrictionType
40
41 Optional text string to indicate special usage rules or restrictions
42 on the item.
43
44 =head2 CirculationStatus
45
46 Optional text string to indicate the current availability of a
47 bibliographic item: available, on loan, lost, etc.
48
49 =head2 HoldQueueLength
50
51 Optional, non-negative integer for the number of user who currently
52 have a hold on the item.
53
54 =head2 DateDue
55
56 Optional date value that specifies the time when the loan of an item
57 will end.
58
59 =head2 ItemDescription
60
61 Optional NCIP::Item::Description object.
62
63 =head2 Location
64
65 Not currently implemented.
66
67 =head2 PhysicalCondition
68
69 Optional NCIP::Item::PhysicalCondition object.
70
71 =head2 ElectronicResource
72
73 Not currently implemented.
74
75 =head2 SecurityMarker
76
77 Optional text sting to specify the type of security used on an item.
78
79 =head2 SensitizationFlag
80
81 Set to 1 when the item should be desensitized or re-sensitized during
82 check out and check in.
83
84 =head2 Ext
85
86 =cut
87
88 NCIP::Item::OptionalFields->mk_accessors(
89     qw(
90           BibliographicDescription
91           ItemUseRestrictionType
92           CirculationStatus
93           HoldQueueLength
94           DateDue
95           ItemDescription
96           Location
97           PhysicalCondition
98           ElectronicResource
99           SecurityMarker
100           SensitizationFlag
101           Ext
102       )
103 );
104
105 1;