]> git.evergreen-ils.org Git - working/NCIPServer.git/blob - lib/NCIP/User/Privilege.pm
Add some more POD to the new user-related classes.
[working/NCIPServer.git] / lib / NCIP / User / Privilege.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::User::Privilege;
20
21 use parent qw(Class::Accessor);
22
23 =head1 NAME
24
25 Privilege - UserPrivilege as defined in Z39.83-1-2012
26
27 =head1 SYNOPSIS
28
29
30
31 =head1 DESCRIPTION
32
33 =head1 FIELDS
34
35 =head2 AgencyId
36
37 Text string with the agency identifier where the privilege originates.
38
39 =head2 AgencyUserPrivilegeType
40
41 Text string with the type of the privilege.
42
43 =head2 ValidFromDate
44
45 Optional start date for the privilege.
46
47 =head2 ValidToDate
48
49 Optional end date for the privilege.
50
51 =head2 UserPrivilegeStatus
52
53 Optional NCIP::User::PrivilegeStatus object.
54
55 =head2 UserPrivilegeDescription
56
57 Optional text string describing the privilege.
58
59 =cut
60
61 NCIP::User::Privilege->mk_accessors(
62     qw(
63           AgencyId
64           AgencyUserPrivilegeType
65           ValidFromDate
66           ValidToDate
67           UserPrivilegeStatus
68           UserPrivilegeDescription
69       )
70 );
71
72 1;