[open-ils-commits] r17048 - trunk/Open-ILS/src/perlmods/OpenILS/Application/Search (miker)

[svn at svn.open-ils.org]

Author: miker
Date: 2010-07-28 10:37:00 -0400 (Wed, 28 Jul 2010)
New Revision: 17048

Modified:
   trunk/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm
Log:
documentation for facet value retrieve method

Modified: trunk/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm
===================================================================
--- trunk/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm	2010-07-27 22:33:34 UTC (rev 17047)
+++ trunk/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm	2010-07-28 14:37:00 UTC (rev 17048)
@@ -1320,7 +1320,24 @@
 
 __PACKAGE__->register_method(
     method   => "retrieve_cached_facets",
-    api_name => "open-ils.search.facet_cache.retrieve"
+    api_name => "open-ils.search.facet_cache.retrieve",
+    signature => {
+        desc   => 'Returns facet data derived from a specific search based on a key '.
+                  'generated by open-ils.search.biblio.multiclass.staged and friends.',
+        params => [
+            {
+                desc => "The facet cache key returned with the initial search as the facet_key hash value",
+                type => 'string',
+            }
+        ],
+        return => {
+            desc => 'Two level hash of facet values.  Top level key is the facet id defined on the config.metabib_field table.  '.
+                    'Second level key is a string facet value.  Datum attached to each facet value is the number of distinct records, '.
+                    'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '.
+                    'facet retrieval.  These counts are calculated for all superpages that have been checked for visibility.',
+            type => 'object',
+        }
+    }
 );