From 4f80a3a3bea74ae8f93dd0a5f637ad1309ee171d Mon Sep 17 00:00:00 2001 From: Jason Stephenson Date: Sun, 17 Aug 2014 09:36:59 -0400 Subject: [PATCH] Add some more POD to the new user-related classes. Signed-off-by: Jason Stephenson --- lib/NCIP/User/BlockOrTrap.pm | 8 ++++++++ lib/NCIP/User/Id.pm | 8 +++++++- lib/NCIP/User/Privilege.pm | 14 +++++++++++++- lib/NCIP/User/PrivilegeStatus.pm | 7 ++++++- 4 files changed, 34 insertions(+), 3 deletions(-) diff --git a/lib/NCIP/User/BlockOrTrap.pm b/lib/NCIP/User/BlockOrTrap.pm index 5f9a8e5..67cba05 100644 --- a/lib/NCIP/User/BlockOrTrap.pm +++ b/lib/NCIP/User/BlockOrTrap.pm @@ -34,12 +34,20 @@ BlockOrTrap - as defined in Z39.83-1-2012 =head2 AgencyId +Text string with the agency identifier for the block or trap. + =head2 BlockOrTrapType +The type of block or trap, i.e. block checkout, block holds.... + =head2 ValidFromDate +Optional date that the block starts. + =head2 ValidToDate +Optional date that the block ends. + =cut NCIP::User::BlockOrTrap->mk_accessors( diff --git a/lib/NCIP/User/Id.pm b/lib/NCIP/User/Id.pm index 1c0eeef..588fa05 100644 --- a/lib/NCIP/User/Id.pm +++ b/lib/NCIP/User/Id.pm @@ -22,7 +22,7 @@ use parent qw(Class::Accessor); =head1 NAME -Id - +Id - UserId obeject as defined in Z39.83-1-2012. =head1 SYNOPSIS @@ -34,10 +34,16 @@ Id - =head2 AgencyId +Text string with the Agency ID. + =head2 UserIdentifierType +Text string with the type of user identifier, i.e. barcode, database id. + =head2 UserIdentifierValue +Text string with the value of the user identifer. + =cut NCIP::User::Id->mk_accessors(qw(AgencyId UserIdentifierType diff --git a/lib/NCIP/User/Privilege.pm b/lib/NCIP/User/Privilege.pm index b875871..fc70002 100644 --- a/lib/NCIP/User/Privilege.pm +++ b/lib/NCIP/User/Privilege.pm @@ -22,7 +22,7 @@ use parent qw(Class::Accessor); =head1 NAME -Privilege - +Privilege - UserPrivilege as defined in Z39.83-1-2012 =head1 SYNOPSIS @@ -34,16 +34,28 @@ Privilege - =head2 AgencyId +Text string with the agency identifier where the privilege originates. + =head2 AgencyUserPrivilegeType +Text string with the type of the privilege. + =head2 ValidFromDate +Optional start date for the privilege. + =head2 ValidToDate +Optional end date for the privilege. + =head2 UserPrivilegeStatus +Optional NCIP::User::PrivilegeStatus object. + =head2 UserPrivilegeDescription +Optional text string describing the privilege. + =cut NCIP::User::Privilege->mk_accessors( diff --git a/lib/NCIP/User/PrivilegeStatus.pm b/lib/NCIP/User/PrivilegeStatus.pm index cb3f258..6606f87 100644 --- a/lib/NCIP/User/PrivilegeStatus.pm +++ b/lib/NCIP/User/PrivilegeStatus.pm @@ -22,7 +22,7 @@ use parent qw(Class::Accessor); =head1 NAME -PrivilegeStatus - +PrivilegeStatus - UserPrivilegeStatus as defined in Z39.83-1-2012. =head1 SYNOPSIS @@ -34,8 +34,13 @@ PrivilegeStatus - =head2 UserPrivilegeStatusType +Text string for the status type, i.e. active, inactive, expired, for +the privilege. + =head2 DateOfUserPrivilegeStatus +Optional date that the privilege entered the given status. + =cut NCIP::User::PrivilegeStatus->mk_accessors( -- 2.43.2