srw/zing.h

   1 /* $Id: zing.h,v 1.1 2003-01-06 08:20:28 adam Exp $
   2    Copyright (C) 2002
   3    Index Data Aps
   4
   5 This file is part of the YAZ toolkit.
   6
   7 See file LICENSE for details.
   8 */
   9 //gsoap zs service name: SRW
  10 //gsoap zs service encoding: literal
  11 //gsoap zs service namespace: http://www.loc.gov/zing/srw/v1.0/
  12 //gsoap zs schema namespace: http://www.loc.gov/zing/srw/v1.0/
  13 //gsoap xcql schema namespace: http://www.loc.gov/zing/cql/v1.0/xcql/
  14 //gsoap xsort schema namespace: http://www.loc.gov/zing/srw/v1.0/xsortkeys/
  15 //gsoap diag schema namespace: http://www.loc.gov/zing/srw/v1.0/diagnostic/
  16
  17 typedef char *xsd__string;
  18 typedef int xsd__integer;
  19 typedef int xsd__boolean;
  20
  21 typedef xsd__string zs__idType;
  22 typedef char *XML;
  23
  24 struct zs__recordType {
  25     xsd__string recordSchema;
  26     xsd__string recordData;
  27     xsd__integer recordPosition 0;
  28 };
  29
  30 struct zs__records {
  31     int __sizeRecords;
  32     struct zs__recordType **record;
  33 };
  34
  35 struct diag__diagnosticType {
  36     xsd__integer code;
  37     xsd__string details 0;
  38 };
  39
  40 struct zs__diagnostics {
  41     int __sizeDiagnostics;
  42     struct diag__diagnosticType **diagnostic;
  43 };
  44
  45 struct zs__searchRetrieveResponse {
  46     xsd__integer numberOfRecords;
  47     xsd__string resultSetId 1;
  48     xsd__integer resultSetIdleTime 0;
  49
  50     struct zs__records records 0;
  51     struct zs__diagnostics diagnostics 0;
  52     xsd__integer *nextRecordPosition 0;
  53     xsd__string debugInfo;
  54 };
  55
  56 struct xcql__prefixType {
  57     xsd__string name;
  58     xsd__string identifier;
  59 };
  60
  61 struct xcql__prefixesType {
  62     int __sizePrefix;
  63     struct xcql__prefixType **prefix;
  64 };
  65
  66 struct xcql__relationType {
  67     xsd__string value;
  68     struct xcql__modifiersType *modifiers 0;
  69 };
  70
  71 struct xcql__searchClauseType {
  72     struct xcql__prefixesType *prefixes 0;
  73     xsd__string index 0;
  74     struct xcql__relationType *relation 0;
  75     xsd__string term;
  76 };
  77
  78 struct xcql__modifierType {
  79     xsd__string type 0;
  80     xsd__string value;
  81 };
  82
  83 struct xcql__modifiersType {
  84     int __sizeModifier;
  85     struct xcql__modifierType **modifier;
  86 };
  87
  88 struct xcql__booleanType {
  89     xsd__string value;
  90     struct xcql__modifiersType *modifiers 0;
  91 };
  92
  93 struct xcql__operandType {
  94     struct xcql__searchClauseType *searchClause 0;
  95     struct xcql__tripleType *triple 0;
  96 };
  97
  98 struct xcql__tripleType {
  99     struct xcql__prefixesType *prefixes 0;
 100     struct xcql__booleanType *boolean;
 101     struct xcql__operandType *leftOperand;
 102     struct xcql__operandType *rightOperand;
 103 };
 104
 105 struct xsort__sortKeyType {
 106     xsd__string path;
 107     xsd__string schema 0;
 108     xsd__boolean ascending 0;
 109     xsd__boolean caseSensitive 0;
 110     xsd__string missingValue 0;
 111 };
 112
 113 struct xsort__xSortKeysType {
 114     int __sizeSortKey;
 115     struct xsort__sortKeyType **sortKey;
 116 };
 117
 118 int zs__searchRetrieveRequest (
 119     xsd__string *query,
 120     struct xcql__operandType *xQuery,
 121     xsd__string *sortKeys,
 122     struct xsort__xSortKeysType *xSortKeys,
 123     xsd__integer *startRecord,
 124     xsd__integer *maximumRecords,
 125     xsd__string *recordSchema,
 126     xsd__string *recordPacking,
 127     struct zs__searchRetrieveResponse *searchRetrieveResponse
 128 );
 129
 130 struct zs__explainResponse {
 131     xsd__string Explain;
 132 };
 133
 134 int zs__explainRequest (
 135     struct zs__explainResponse *explainResponse
 136 );