[open-ils-commits] r16072 - trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ (erickson)

[svn at svn.open-ils.org]

Author: erickson
Date: 2010-03-31 15:44:18 -0400 (Wed, 31 Mar 2010)
New Revision: 16072

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
Log:
fleshed out the docs for the open-ils.circ.hold.has_copy_at method

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm	2010-03-31 19:38:02 UTC (rev 16071)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Circ/Holds.pm	2010-03-31 19:44:18 UTC (rev 16072)
@@ -2276,10 +2276,31 @@
 __PACKAGE__->register_method(
     method    => 'hold_has_copy_at',
     api_name  => 'open-ils.circ.hold.has_copy_at',
-    signature => q/
-        Returns the ID of the found copy and name of the shelving location if there is
-        an available copy at the specified org unit.  Returns empty hash otherwise.
-    /
+    signature => {
+        desc => q/
+            Returns the ID of the found copy and name of the shelving location if there is
+            an available copy at the specified org unit.  Returns empty hash otherwise.
+            The anticipated use for this method is to determine whether an item is
+            available at the library where the user is placing the hold (or, alternatively, 
+            at the pickup library) to encourage bypassing the hold placement and just 
+            checking out the item.
+        /,
+        params => {
+            { desc => 'Authentication Token', type => 'string' },
+            { desc => q/
+                    Method Arguments.  Options include:
+                    hold_type  : the hold type code (T, V, C, M, ...)
+                    hold_target : the identifier of the hold target object
+                    org_unit : org unit ID
+                /, 
+                type => 'object' 
+            },
+        },
+        return => { 
+            desc => q/{ "copy" : copy_id, "location" : location_name }/,
+            type => 'object' 
+        }
+    }
 );
 
 sub hold_has_copy_at {