X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fsrw.h;h=4e37f4526ef5a492e2784cce160b10b0c915a0ce;hp=a1ecadd5e7f9b3b1adc5f1f1c3d8bea2befdc048;hb=0d191bf4a0a8f0196e0ba1c42f0070255c04c1b4;hpb=06eb0818f902a5d6805b656e0ba2e39ac2ed7817 diff --git a/include/yaz/srw.h b/include/yaz/srw.h index a1ecadd..4e37f45 100644 --- a/include/yaz/srw.h +++ b/include/yaz/srw.h @@ -1,8 +1,12 @@ /* - * Copyright (c) 2002-2003, Index Data. + * Copyright (C) 1995-2005, Index Data ApS * See the file LICENSE for details. * - * $Id: srw.h,v 1.9 2003-12-20 00:51:19 adam Exp $ + * $Id: srw.h,v 1.23 2005-11-08 15:08:02 adam Exp $ + */ +/** + * \file srw.h + * \brief Header for SRW/SRU */ #ifndef YAZ_SRW_H @@ -10,22 +14,35 @@ #include #include +#include YAZ_BEGIN_CDECL typedef struct { + int type; + char *recordReviewCode; + char *recordReviewNote; + char *recordId; + char *nonDupRecordId; + char *recordLockStatus; + char *recordOldVersion; +} Z_SRW_extra_record; + +typedef struct { char *recordSchema; int recordPacking; #define Z_SRW_recordPacking_string 0 #define Z_SRW_recordPacking_XML 1 +#define Z_SRW_recordPacking_URL 2 char *recordData_buf; int recordData_len; int *recordPosition; } Z_SRW_record; typedef struct { - int *code; + char *uri; char *details; + char *message; } Z_SRW_diagnostic; typedef struct { @@ -50,10 +67,13 @@ typedef struct { char *xSortKeys; } sort; int *startRecord; - int *maximumRecords; + int *maximumRecords; char *recordSchema; char *recordPacking; + char *recordXPath; char *database; + char *stylesheet; + int *resultSetTTL; } Z_SRW_searchRetrieveRequest; typedef struct { @@ -67,21 +87,83 @@ typedef struct { Z_SRW_diagnostic *diagnostics; int num_diagnostics; int *nextRecordPosition; + + Z_SRW_extra_record **extra_records; /* of size num_records */ } Z_SRW_searchRetrieveResponse; typedef struct { char *recordPacking; char *database; + char *stylesheet; } Z_SRW_explainRequest; typedef struct { Z_SRW_record record; + Z_SRW_diagnostic *diagnostics; + int num_diagnostics; + Z_SRW_extra_record *extra_record; } Z_SRW_explainResponse; +typedef struct { + int query_type; + union { + char *cql; + char *xcql; + char *pqf; + } scanClause; + int *responsePosition; + int *maximumTerms; + char *stylesheet; + char *database; +} Z_SRW_scanRequest; + +typedef struct { + char *value; + int *numberOfRecords; + char *displayTerm; + char *whereInList; +} Z_SRW_scanTerm; + +typedef struct { + Z_SRW_scanTerm *terms; + int num_terms; + Z_SRW_diagnostic *diagnostics; + int num_diagnostics; +} Z_SRW_scanResponse; + + +typedef struct { + char *database; + char *operation; + char *recordId; + char *recordVersion; + char *recordOldVersion; + Z_SRW_record record; + Z_SRW_extra_record *extra_record; + char *extraRequestData; + char *stylesheet; +} Z_SRW_updateRequest; + +typedef struct { + char *operationStatus; + char *recordId; + char *recordVersion; + char *recordChecksum; + char *extraResponseData; + Z_SRW_record record; + Z_SRW_extra_record *extra_record; + Z_SRW_diagnostic *diagnostics; + int num_diagnostics; +} Z_SRW_updateResponse; + #define Z_SRW_searchRetrieve_request 1 #define Z_SRW_searchRetrieve_response 2 #define Z_SRW_explain_request 3 #define Z_SRW_explain_response 4 +#define Z_SRW_scan_request 5 +#define Z_SRW_scan_response 6 +#define Z_SRW_update_request 7 +#define Z_SRW_update_response 8 typedef struct { int which; @@ -90,17 +172,22 @@ typedef struct { Z_SRW_searchRetrieveResponse *response; Z_SRW_explainRequest *explain_request; Z_SRW_explainResponse *explain_response; + Z_SRW_scanRequest *scan_request; + Z_SRW_scanResponse *scan_response; + Z_SRW_updateRequest *update_request; + Z_SRW_updateResponse *update_response; } u; char *srw_version; - char *database; } Z_SRW_PDU; YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr, Z_SRW_PDU **handler_data, void *client_data, const char *ns); +YAZ_EXPORT int yaz_ucp_codec(ODR o, void * pptr, + Z_SRW_PDU **handler_data, + void *client_data, const char *ns); YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which); - -YAZ_EXPORT const char *yaz_diag_srw_str (int code); +YAZ_EXPORT Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o); YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code); @@ -108,11 +195,28 @@ YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code); YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o); YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name, - ODR o, int **intp); -YAZ_EXPORT int yaz_check_for_srw(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, - char **soap_ns, ODR decode); -YAZ_EXPORT int yaz_check_for_sru(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, - char **soap_ns, ODR decode); + ODR o, int **intp); +YAZ_EXPORT int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, + Z_SOAP **soap_package, ODR decode, char **charset); +YAZ_EXPORT int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, + Z_SOAP **soap_package, ODR decode, + char **charset, + Z_SRW_diagnostic **, int *num_diagnostic); + +YAZ_EXPORT void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d, + int *num, int code, + const char *addinfo); + +YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d, + int code, const char *details); YAZ_END_CDECL #endif +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +