Change wording ot YAZ license the 'Revised BSD License'. YAZ has used a

[yaz-moved-to-github.git] / include / yaz / retrieval.h

diff --git a/include/yaz/retrieval.h b/include/yaz/retrieval.h
index 8ef3a98..22ba84b 100644 (file)
--- a/include/yaz/retrieval.h
+++ b/include/yaz/retrieval.h
@@ -1,30 +1,31 @@
 /*
- * Copyright (C) 2005-2006, Index Data ApS
+ * Copyright (c) 1995-2006, Index Data
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
  *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation, in whole or in part, for any purpose, is hereby granted,
- * provided that:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Index Data nor the names of its contributors
+ *       may be used to endorse or promote products derived from this
+ *       software without specific prior written permission.
  *
- * 1. This copyright and permission notice appear in all copies of the
- * software and its documentation. Notices of copyright or attribution
- * which appear at the beginning of any file must remain unchanged.
- *
- * 2. The name of Index Data or the individual authors may not be used to
- * endorse or promote products derived from this software without specific
- * prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
- * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
- * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
- *
- * $Id: retrieval.h,v 1.1 2006-05-04 20:00:45 adam Exp $
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+/* $Id: retrieval.h,v 1.6 2006-10-09 21:02:41 adam Exp $ */
+
 /**
  * \file retrieval.h
  * \brief Retrieval Utility
@@ -67,9 +68,9 @@ YAZ_EXPORT void yaz_retrieval_destroy(yaz_retrieval_t p);
     <retrievalinfo>
        <retrieval syntax="usmarc" name="marcxml"
             identifier="info:srw/schema/1/marcxml-v1.1"
+            backendsyntax="xml" backendname="dc"
        >
          <title>MARCXML</title>
-         <backend syntax="xml" name="dc" charset="utf-8"/>
          <convert>
             <marc inputformat="marc" outputformat="marcxml"
                          inputcharset="marc-8"/>
@@ -86,15 +87,26 @@ int yaz_retrieval_configure(yaz_retrieval_t p, const void *node);
 
 /** performs retrieval request based on schema and format
     \param p retrieval handle
-    \param schema record schema / element set name (Z39.50)
-    \param format record format (syntax)
-    \param rc record conversion reference (holds conversion upon success)
-    \retval 0 success
-    \retval -1 falure
+    \param schema record schema (SRU) / element set name (Z39.50)
+    \param syntax record syntax (format)
+    \param match_schema matched schema (if conversion was successful)
+    \param match_syntax matced syntax OID  if conversion was successful)
+    \param rc record conversion reference (if conversion was successful)
+    \param backend_schema backend scchema (if conversion was successful)
+    \param backend_syntax backend syntax (if conversion was successful)
+    \retval 0 success, schema and syntax matches
+    \retval -1 failure, use yaz_retrieval_get_error() for reason
+    \retval 1 schema does not match
+    \retval 2 syntax does not match
+    \retval 3 both match but not together
 */
 YAZ_EXPORT
-int yaz_retrieval_request(yaz_retrieval_t p, const char *schema,
-                          const char *format, yaz_record_conv_t *rc);
+int yaz_retrieval_request(yaz_retrieval_t p,
+                          const char *schema, int *syntax,
+                          const char **match_schema, int **match_syntax,
+                          yaz_record_conv_t *rc,
+                          const char **backend_schema,
+                          int **backend_syntax);
 
 /** returns error string (for last error)
     \param p record conversion handle