2 * Copyright (c) 1995-1998, Index Data.
4 * Permission to use, copy, modify, distribute, and sell this software and
5 * its documentation, in whole or in part, for any purpose, is hereby granted,
8 * 1. This copyright and permission notice appear in all copies of the
9 * software and its documentation. Notices of copyright or attribution
10 * which appear at the beginning of any file must remain unchanged.
12 * 2. The name of Index Data or the individual authors may not be used to
13 * endorse or promote products derived from this software without specific
14 * prior written permission.
16 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
27 * Revision 1.42 1998-03-20 14:46:06 adam
28 * Added UNIverse Resource Reports.
30 * Revision 1.41 1998/02/10 15:31:52 adam
31 * Implemented date and time structure. Changed the Update Extended
34 * Revision 1.40 1997/09/01 08:49:50 adam
35 * New windows NT/95 port using MSV5.0. To export DLL functions the
36 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
38 * Revision 1.39 1997/05/14 06:53:44 adam
41 * Revision 1.38 1997/04/30 08:52:09 quinn
44 * Revision 1.37 1996/10/09 15:54:58 quinn
45 * Added SearchInfoReport
47 * Revision 1.36 1996/10/07 15:29:20 quinn
50 * Revision 1.35 1996/06/10 08:57:38 quinn
51 * Added OPAC, ResourceReport
53 * Revision 1.34 1996/06/10 08:55:36 quinn
56 * Revision 1.33 1996/02/23 10:00:51 quinn
59 * Revision 1.32 1996/02/20 12:52:39 quinn
62 * Revision 1.31 1996/01/22 09:46:45 quinn
63 * Added Sort PDU. Moved StringList to main protocol file.
65 * Revision 1.30 1996/01/10 15:21:32 quinn
66 * Added links to access control PDUs
68 * Revision 1.29 1996/01/02 11:46:49 quinn
69 * Changed 'operator' to 'roperator' to avoid C++ conflict.
72 * Revision 1.28 1996/01/02 08:57:32 quinn
73 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
75 * Revision 1.27 1995/10/12 10:34:46 quinn
78 * Revision 1.26 1995/09/29 17:12:08 quinn
81 * Revision 1.25 1995/09/27 15:02:49 quinn
82 * Modified function heads & prototypes.
84 * Revision 1.24 1995/08/29 11:17:43 quinn
85 * *** empty log message ***
87 * Revision 1.23 1995/08/21 09:10:36 quinn
88 * Smallish fixes to suppport new formats.
90 * Revision 1.22 1995/08/17 12:45:14 quinn
91 * Fixed minor problems with GRS-1. Added support in c&s.
93 * Revision 1.21 1995/08/15 12:00:11 quinn
96 * Revision 1.20 1995/08/10 08:54:35 quinn
99 * Revision 1.19 1995/06/19 12:38:28 quinn
100 * Reorganized include-files. Added small features.
102 * Revision 1.18 1995/06/16 13:16:05 quinn
103 * Fixed Defaultdiagformat.
105 * Revision 1.17 1995/06/15 15:42:05 quinn
108 * Revision 1.16 1995/06/15 07:45:06 quinn
111 * Revision 1.15 1995/06/14 15:26:43 quinn
112 * *** empty log message ***
114 * Revision 1.14 1995/06/07 14:42:34 quinn
117 * Revision 1.13 1995/06/07 14:36:47 quinn
120 * Revision 1.12 1995/06/05 10:53:13 quinn
123 * Revision 1.11 1995/06/02 09:49:47 quinn
126 * Revision 1.10 1995/05/29 08:11:34 quinn
127 * Moved oid from odr/asn to util.
129 * Revision 1.9 1995/05/22 11:31:25 quinn
132 * Revision 1.8 1995/05/17 08:41:35 quinn
133 * Added delete to proto & other little things.
134 * Relaying auth info to backend.
136 * Revision 1.7 1995/05/16 08:50:37 quinn
137 * License, documentation, and memory fixes
139 * Revision 1.6 1995/05/15 11:55:55 quinn
140 * Work on asynchronous activity.
142 * Revision 1.5 1995/04/17 11:28:18 quinn
145 * Revision 1.4 1995/04/10 10:22:47 quinn
148 * Revision 1.3 1995/03/30 12:18:09 quinn
151 * Revision 1.2 1995/03/30 10:26:48 quinn
152 * Added Term structure
154 * Revision 1.1 1995/03/30 09:39:42 quinn
155 * Moved .h files to include directory
157 * Revision 1.11 1995/03/30 09:08:44 quinn
158 * Added Resource control protocol
160 * Revision 1.10 1995/03/29 15:39:39 quinn
161 * Adding some resource control elements, and a null-check to getentbyoid
163 * Revision 1.9 1995/03/29 08:06:18 quinn
164 * Added a few v3 elements
166 * Revision 1.8 1995/03/22 10:12:49 quinn
167 * Added Z_PRES constants.
169 * Revision 1.7 1995/03/20 09:45:12 quinn
172 * Revision 1.5 1995/03/07 16:29:34 quinn
173 * Added authentication stuff.
175 * Revision 1.4 1995/03/07 10:13:00 quinn
176 * Added prototype for z_APDU()
178 * Revision 1.3 1995/02/14 11:54:23 quinn
181 * Revision 1.2 1995/02/09 15:51:40 quinn
184 * Revision 1.1 1995/02/06 16:44:48 quinn
185 * First hack at Z/SR protocol
196 #include <yaz-version.h>
203 * Because we didn't have time to put all of the extra v3 elements in here
204 * before the first applications were written, we have to place them
205 * in #ifdefs in places where they would break existing code. If you are
206 * developing new stuff, we urge you to leave them in, even if you don't
207 * intend to use any v3 features. When we are comfortable that the old
208 * apps have been updated, we'll remove the #ifdefs.
213 /* ----------------- GLOBAL AUXILIARY DEFS ----------------*/
216 typedef struct Z_External Z_External;
218 typedef Odr_oct Z_ReferenceId;
219 typedef char Z_DatabaseName;
220 typedef char Z_ResultSetId;
221 typedef Odr_oct Z_ResultsetId;
223 typedef struct Z_InfoCategory
225 Odr_oid *categoryTypeId; /* OPTIONAL */
229 typedef struct Z_OtherInformationUnit
231 Z_InfoCategory *category; /* OPTIONAL */
233 #define Z_OtherInfo_characterInfo 0
234 #define Z_OtherInfo_binaryInfo 1
235 #define Z_OtherInfo_externallyDefinedInfo 2
236 #define Z_OtherInfo_oid 3
241 Z_External *externallyDefinedInfo;
244 } Z_OtherInformationUnit;
246 typedef struct Z_OtherInformation
249 Z_OtherInformationUnit **list;
250 } Z_OtherInformation;
252 typedef struct Z_StringOrNumeric
255 #define Z_StringOrNumeric_string 0
256 #define Z_StringOrNumeric_numeric 1
264 typedef struct Z_Unit
266 char *unitSystem; /* OPTIONAL */
267 Z_StringOrNumeric *unitType; /* OPTIONAL */
268 Z_StringOrNumeric *unit; /* OPTIONAL */
269 int *scaleFactor; /* OPTIONAL */
272 typedef struct Z_IntUnit
278 typedef Odr_oct Z_SUTRS;
280 typedef struct Z_StringList
286 /* ----------------- INIT SERVICE ----------------*/
290 char *groupId; /* OPTIONAL */
291 char *userId; /* OPTIONAL */
292 char *password; /* OPTIONAL */
295 typedef struct Z_IdAuthentication
298 #define Z_IdAuthentication_open 0
299 #define Z_IdAuthentication_idPass 1
300 #define Z_IdAuthentication_anonymous 2
301 #define Z_IdAuthentication_other 3
309 } Z_IdAuthentication;
311 #define Z_ProtocolVersion_1 0
312 #define Z_ProtocolVersion_2 1
313 #define Z_ProtocolVersion_3 2
315 #define Z_Options_search 0
316 #define Z_Options_present 1
317 #define Z_Options_delSet 2
318 #define Z_Options_resourceReport 3
319 #define Z_Options_triggerResourceCtrl 4
320 #define Z_Options_resourceCtrl 5
321 #define Z_Options_accessCtrl 6
322 #define Z_Options_scan 7
323 #define Z_Options_sort 8
324 #define Z_Options_reserved 9
325 #define Z_Options_extendedServices 10
326 #define Z_Options_level_1Segmentation 11
327 #define Z_Options_level_2Segmentation 12
328 #define Z_Options_concurrentOperations 13
329 #define Z_Options_namedResultSets 14
331 typedef struct Z_InitRequest
333 Z_ReferenceId *referenceId; /* OPTIONAL */
334 Odr_bitmask *protocolVersion;
335 Odr_bitmask *options;
336 int *preferredMessageSize;
337 int *maximumRecordSize;
338 Z_IdAuthentication* idAuthentication; /* OPTIONAL */
339 char *implementationId; /* OPTIONAL */
340 char *implementationName; /* OPTIONAL */
341 char *implementationVersion; /* OPTIONAL */
342 Z_External *userInformationField; /* OPTIONAL */
344 Z_OtherInformation *otherInfo; /* OPTIONAL */
348 typedef struct Z_InitResponse
350 Z_ReferenceId *referenceId; /* OPTIONAL */
351 Odr_bitmask *protocolVersion;
352 Odr_bitmask *options;
353 int *preferredMessageSize;
354 int *maximumRecordSize;
356 char *implementationId; /* OPTIONAL */
357 char *implementationName; /* OPTIONAL */
358 char *implementationVersion; /* OPTIONAL */
359 Z_External *userInformationField; /* OPTIONAL */
361 Z_OtherInformation *otherInfo; /* OPTIONAL */
365 typedef struct Z_NSRAuthentication
370 } Z_NSRAuthentication;
372 int z_NSRAuthentication(ODR o, Z_NSRAuthentication **p, int opt);
374 int z_StrAuthentication(ODR o, char **p, int opt);
376 /* ------------------ SEARCH SERVICE ----------------*/
378 typedef struct Z_DatabaseSpecificUnit
381 char *elementSetName;
382 } Z_DatabaseSpecificUnit;
384 typedef struct Z_DatabaseSpecific
387 Z_DatabaseSpecificUnit **elements;
388 } Z_DatabaseSpecific;
390 typedef struct Z_ElementSetNames
393 #define Z_ElementSetNames_generic 0
394 #define Z_ElementSetNames_databaseSpecific 1
398 Z_DatabaseSpecific *databaseSpecific;
402 /* ---------------------- RPN QUERY --------------------------- */
404 typedef struct Z_ComplexAttribute
407 Z_StringOrNumeric **list;
408 int num_semanticAction;
409 int **semanticAction; /* OPTIONAL */
410 } Z_ComplexAttribute;
412 typedef struct Z_AttributeElement
415 Odr_oid *attributeSet; /* OPTIONAL - v3 only */
420 #define Z_AttributeValue_numeric 0
421 #define Z_AttributeValue_complex 1
425 Z_ComplexAttribute *complex;
430 } Z_AttributeElement;
432 typedef struct Z_Term
435 #define Z_Term_general 0
436 #define Z_Term_numeric 1
437 #define Z_Term_characterString 2
439 #define Z_Term_dateTime 4
440 #define Z_Term_external 5
441 #define Z_Term_integerAndUnit 6
442 #define Z_Term_null 7
445 Odr_oct *general; /* this is required for v2 */
447 char *characterString;
450 Z_External *external;
451 /* Z_IntUnit *integerAndUnit; */
456 typedef struct Z_AttributesPlusTerm
459 Z_AttributeElement **attributeList;
461 } Z_AttributesPlusTerm;
463 typedef struct Z_ResultSetPlusAttributes
467 Z_AttributeElement **attributeList;
468 } Z_ResultSetPlusAttributes;
470 typedef struct Z_ProximityOperator
472 bool_t *exclusion; /* OPTIONAL */
476 #define Z_Prox_lessThan 1
477 #define Z_Prox_lessThanOrEqual 2
478 #define Z_Prox_equal 3
479 #define Z_Prox_greaterThanOrEqual 4
480 #define Z_Prox_greaterThan 5
481 #define Z_Prox_notEqual 6
483 #define Z_ProxCode_known 0
484 #define Z_ProxCode_private 1
485 int *proximityUnitCode;
486 #define Z_ProxUnit_character 1
487 #define Z_ProxUnit_word 2
488 #define Z_ProxUnit_sentence 3
489 #define Z_ProxUnit_paragraph 4
490 #define Z_ProxUnit_section 5
491 #define Z_ProxUnit_chapter 6
492 #define Z_ProxUnit_document 7
493 #define Z_ProxUnit_element 8
494 #define Z_ProxUnit_subelement 9
495 #define Z_ProxUnit_elementType 10
496 #define Z_ProxUnit_byte 11 /* v3 only */
497 } Z_ProximityOperator;
499 typedef struct Z_Operator
502 #define Z_Operator_and 0
503 #define Z_Operator_or 1
504 #define Z_Operator_and_not 2
505 #define Z_Operator_prox 3
508 Odr_null *and; /* these guys are nulls. */
511 Z_ProximityOperator *prox;
515 typedef struct Z_Operand
518 #define Z_Operand_APT 0
519 #define Z_Operand_resultSetId 1
520 #define Z_Operand_resultAttr /* v3 only */ 2
523 Z_AttributesPlusTerm *attributesPlusTerm;
524 Z_ResultSetId *resultSetId;
525 Z_ResultSetPlusAttributes *resultAttr;
529 typedef struct Z_Complex
531 struct Z_RPNStructure *s1;
532 struct Z_RPNStructure *s2;
533 Z_Operator *roperator;
536 typedef struct Z_RPNStructure
539 #define Z_RPNStructure_simple 0
540 #define Z_RPNStructure_complex 1
548 typedef struct Z_RPNQuery
550 Odr_oid *attributeSetId;
551 Z_RPNStructure *RPNStructure;
554 /* -------------------------- SEARCHREQUEST -------------------------- */
556 typedef struct Z_Query
559 #define Z_Query_type_1 1
560 #define Z_Query_type_2 2
561 #define Z_Query_type_101 3
566 Z_RPNQuery *type_101;
570 typedef struct Z_SearchRequest
572 Z_ReferenceId *referenceId; /* OPTIONAL */
573 int *smallSetUpperBound;
574 int *largeSetLowerBound;
575 int *mediumSetPresentNumber;
576 bool_t *replaceIndicator;
578 int num_databaseNames;
579 char **databaseNames;
580 Z_ElementSetNames *smallSetElementSetNames; /* OPTIONAL */
581 Z_ElementSetNames *mediumSetElementSetNames; /* OPTIONAL */
582 Odr_oid *preferredRecordSyntax; /* OPTIONAL */
585 Z_OtherInformation *additionalSearchInfo; /* OPTIONAL */
586 Z_OtherInformation *otherInfo; /* OPTIONAL */
590 /* ------------------------ RECORD -------------------------- */
592 typedef Z_External Z_DatabaseRecord;
596 typedef struct Z_DefaultDiagFormat
598 Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
600 /* until the whole character set issue becomes more definite,
601 * you can probably ignore this on input. */
603 #define Z_DiagForm_v2AddInfo 0
604 #define Z_DiagForm_v3AddInfo 1
606 } Z_DefaultDiagFormat;
608 typedef struct Z_DiagRec
611 #define Z_DiagRec_defaultFormat 0
612 #define Z_DiagRec_externallyDefined 1
615 Z_DefaultDiagFormat *defaultFormat;
616 Z_External *externallyDefined;
622 typedef struct Z_DiagRec
624 Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
631 typedef struct Z_DiagRecs
634 Z_DiagRec **diagRecs;
637 typedef struct Z_NamePlusRecord
639 char *databaseName; /* OPTIONAL */
641 #define Z_NamePlusRecord_databaseRecord 0
642 #define Z_NamePlusRecord_surrogateDiagnostic 1
645 Z_DatabaseRecord *databaseRecord;
646 Z_DiagRec *surrogateDiagnostic;
650 typedef struct Z_NamePlusRecordList
653 Z_NamePlusRecord **records;
654 } Z_NamePlusRecordList;
656 typedef struct Z_Records
659 #define Z_Records_DBOSD 0
660 #define Z_Records_NSD 1
661 #define Z_Records_multipleNSD 2
664 Z_NamePlusRecordList *databaseOrSurDiagnostics;
665 Z_DiagRec *nonSurrogateDiagnostic;
666 Z_DiagRecs *multipleNonSurDiagnostics;
670 /* ------------------------ SEARCHRESPONSE ------------------ */
672 typedef struct Z_SearchResponse
674 Z_ReferenceId *referenceId; /* OPTIONAL */
676 int *numberOfRecordsReturned;
677 int *nextResultSetPosition;
678 bool_t *searchStatus;
679 int *resultSetStatus; /* OPTIONAL */
680 #define Z_RES_SUBSET 1
681 #define Z_RES_INTERIM 2
683 int *presentStatus; /* OPTIONAL */
684 #define Z_PRES_SUCCESS 0
685 #define Z_PRES_PARTIAL_1 1
686 #define Z_PRES_PARTIAL_2 2
687 #define Z_PRES_PARTIAL_3 3
688 #define Z_PRES_PARTIAL_4 4
689 #define Z_PRES_FAILURE 5
690 Z_Records *records; /* OPTIONAL */
692 Z_OtherInformation *additionalSearchInfo;
693 Z_OtherInformation *otherInfo;
697 /* ------------------------- PRESENT SERVICE -----------------*/
699 typedef struct Z_ElementSpec
702 #define Z_ElementSpec_elementSetName 0
703 #define Z_ElementSpec_externalSpec 1
706 char *elementSetName;
707 Z_External *externalSpec;
711 typedef struct Z_Specification
713 Odr_oid *schema; /* OPTIONAL */
714 Z_ElementSpec *elementSpec; /* OPTIONAL */
717 typedef struct Z_DbSpecific
720 Z_Specification *spec;
723 typedef struct Z_CompSpec
725 bool_t *selectAlternativeSyntax;
726 Z_Specification *generic; /* OPTIONAL */
728 Z_DbSpecific **dbSpecific; /* OPTIONAL */
729 int num_recordSyntax;
730 Odr_oid **recordSyntax; /* OPTIONAL */
733 typedef struct Z_RecordComposition
736 #define Z_RecordComp_simple 0
737 #define Z_RecordComp_complex 1
740 Z_ElementSetNames *simple;
743 } Z_RecordComposition;
745 typedef struct Z_Range
747 int *startingPosition;
748 int *numberOfRecords;
751 typedef struct Z_PresentRequest
753 Z_ReferenceId *referenceId; /* OPTIONAL */
754 Z_ResultSetId *resultSetId;
755 int *resultSetStartPoint;
756 int *numberOfRecordsRequested;
759 Z_Range **additionalRanges; /* OPTIONAL */
760 Z_RecordComposition *recordComposition; /* OPTIONAL */
762 Z_ElementSetNames *elementSetNames; /* OPTIONAL */
764 Odr_oid *preferredRecordSyntax; /* OPTIONAL */
766 int *maxSegmentCount; /* OPTIONAL */
767 int *maxRecordSize; /* OPTIONAL */
768 int *maxSegmentSize; /* OPTIONAL */
769 Z_OtherInformation *otherInfo; /* OPTIONAL */
773 typedef struct Z_PresentResponse
775 Z_ReferenceId *referenceId; /* OPTIONAL */
776 int *numberOfRecordsReturned;
777 int *nextResultSetPosition;
781 Z_OtherInformation *otherInfo; /* OPTIONAL */
785 /* ------------------ RESOURCE CONTROL ----------------*/
787 typedef struct Z_TriggerResourceControlRequest
789 Z_ReferenceId *referenceId; /* OPTIONAL */
790 int *requestedAction;
791 #define Z_TriggerResourceCtrl_resourceReport 1
792 #define Z_TriggerResourceCtrl_resourceControl 2
793 #define Z_TriggerResourceCtrl_cancel 3
794 Odr_oid *prefResourceReportFormat; /* OPTIONAL */
795 bool_t *resultSetWanted; /* OPTIONAL */
797 Z_OtherInformation *otherInfo;
799 } Z_TriggerResourceControlRequest;
801 typedef struct Z_ResourceControlRequest
803 Z_ReferenceId *referenceId; /* OPTIONAL */
804 bool_t *suspendedFlag; /* OPTIONAL */
805 Z_External *resourceReport; /* OPTIONAL */
806 int *partialResultsAvailable; /* OPTIONAL */
807 #define Z_ResourceControlRequest_subset 1
808 #define Z_ResourceControlRequest_interim 2
809 #define Z_ResourceControlRequest_none 3
810 bool_t *responseRequired;
811 bool_t *triggeredRequestFlag; /* OPTIONAL */
813 Z_OtherInformation *otherInfo;
815 } Z_ResourceControlRequest;
817 typedef struct Z_ResourceControlResponse
819 Z_ReferenceId *referenceId; /* OPTIONAL */
820 bool_t *continueFlag;
821 bool_t *resultSetWanted; /* OPTIONAL */
823 Z_OtherInformation *otherInfo;
825 } Z_ResourceControlResponse;
828 /* ------------------ ACCESS CTRL SERVICE ----------------*/
830 typedef struct Z_AccessControlRequest
832 Z_ReferenceId *referenceId; /* OPTIONAL */
834 #define Z_AccessRequest_simpleForm 0
835 #define Z_AccessRequest_externallyDefined 1
839 Z_External *externallyDefined;
842 Z_OtherInformation *otherInfo; /* OPTIONAL */
844 } Z_AccessControlRequest;
846 typedef struct Z_AccessControlResponse
848 Z_ReferenceId *referenceId; /* OPTIONAL */
850 #define Z_AccessResponse_simpleForm 0
851 #define Z_AccessResponse_externallyDefined 1
855 Z_External *externallyDefined;
857 Z_DiagRec *diagnostic; /* OPTIONAL */
859 Z_OtherInformation *otherInfo; /* OPTIONAL */
861 } Z_AccessControlResponse;
863 /* ------------------------ SCAN SERVICE -------------------- */
865 typedef struct Z_AttributeList
868 Z_AttributeElement **attributes;
871 typedef struct Z_AlternativeTerm
874 Z_AttributesPlusTerm **terms;
879 typedef struct Z_ByDatabase
882 int *num; /* OPTIONAL */
883 Z_OtherInformation *otherDbInfo; /* OPTIONAL */
886 typedef struct Z_ByDatabaseList
889 Z_ByDatabase **elements;
892 typedef struct Z_ScanOccurrences
895 #define Z_ScanOccurrences_global 0
896 #define Z_ScanOccurrences_byDatabase 1
900 Z_ByDatabaseList *byDatabase;
905 typedef struct Z_OccurrenceByAttributesElem
907 Z_AttributeList *attributes;
908 Z_ScanOccurrences *occurrences; /* OPTIONAL */
909 Z_OtherInformation *otherOccurInfo; /* OPTIONAL */
910 } Z_OccurrenceByAttributesElem;
912 typedef struct Z_OccurrenceByAttributes
915 Z_OccurrenceByAttributesElem **elements;
916 } Z_OccurrenceByAttributes;
921 * Old, incomplete definition of OccurrenceByAttributes.
924 typedef struct Z_OccurrenceByAttributes
926 Z_AttributeList *attributes;
929 #define Z_OByAtt_global 0
930 #define Z_ObyAtt_byDatabase 1
936 /* Z_ByDatabase *byDatabase; */
939 } Z_OccurrenceByAttributes;
943 typedef struct Z_TermInfo
946 char *displayTerm; /* OPTIONAL */
947 Z_AttributeList *suggestedAttributes; /* OPTIONAL */
948 Z_AlternativeTerm *alternativeTerm; /* OPTIONAL */
949 int *globalOccurrences; /* OPTIONAL */
950 Z_OccurrenceByAttributes *byAttributes; /* OPTIONAL */
951 Z_OtherInformation *otherTermInfo; /* OPTIONAL */
954 typedef struct Z_Entry
957 #define Z_Entry_termInfo 0
958 #define Z_Entry_surrogateDiagnostic 1
961 Z_TermInfo *termInfo;
962 Z_DiagRec *surrogateDiagnostic;
966 typedef struct Z_Entries
972 typedef struct Z_ListEntries
975 #define Z_ListEntries_entries 0
976 #define Z_ListEntries_nonSurrogateDiagnostics 1
980 Z_DiagRecs *nonSurrogateDiagnostics;
984 typedef struct Z_ScanRequest
986 Z_ReferenceId *referenceId; /* OPTIONAL */
987 int num_databaseNames;
988 char **databaseNames;
989 Odr_oid *attributeSet; /* OPTIONAL */
990 Z_AttributesPlusTerm *termListAndStartPoint;
991 int *stepSize; /* OPTIONAL */
992 int *numberOfTermsRequested;
993 int *preferredPositionInResponse; /* OPTIONAL */
995 Z_OtherInformation *otherInfo;
999 typedef struct Z_ScanResponse
1001 Z_ReferenceId *referenceId; /* OPTIONAL */
1002 int *stepSize; /* OPTIONAL */
1004 #define Z_Scan_success 0
1005 #define Z_Scan_partial_1 1
1006 #define Z_Scan_partial_2 2
1007 #define Z_Scan_partial_3 3
1008 #define Z_Scan_partial_4 4
1009 #define Z_Scan_partial_5 5
1010 #define Z_Scan_failure 6
1011 int *numberOfEntriesReturned;
1012 int *positionOfTerm; /* OPTIONAL */
1013 Z_ListEntries *entries; /* OPTIONAL */
1014 Odr_oid *attributeSet; /* OPTIONAL */
1016 Z_OtherInformation *otherInfo;
1021 /* ------------------------ DELETE -------------------------- */
1023 #define Z_DeleteStatus_success 0
1024 #define Z_DeleteStatus_resultSetDidNotExist 1
1025 #define Z_DeleteStatus_previouslyDeletedByTarget 2
1026 #define Z_DeleteStatus_systemProblemAtTarget 3
1027 #define Z_DeleteStatus_accessNotAllowed 4
1028 #define Z_DeleteStatus_resourceControlAtOrigin 5
1029 #define Z_DeleteStatus_resourceControlAtTarget 6
1030 #define Z_DeleteStatus_bulkDeleteNotSupported 7
1031 #define Z_DeleteStatus_notAllRsltSetsDeletedOnBulkDlte 8
1032 #define Z_DeleteStatus_notAllRequestedResultSetsDeleted 9
1033 #define Z_DeleteStatus_resultSetInUse 10
1035 typedef struct Z_ListStatus
1041 typedef struct Z_DeleteResultSetRequest
1043 Z_ReferenceId *referenceId; /* OPTIONAL */
1044 int *deleteFunction;
1045 #define Z_DeleteRequest_list 0
1046 #define Z_DeleteRequest_all 1
1048 Z_ResultSetId **resultSetList; /* OPTIONAL */
1050 Z_OtherInformation *otherInfo;
1052 } Z_DeleteResultSetRequest;
1054 typedef struct Z_DeleteResultSetResponse
1056 Z_ReferenceId *referenceId; /* OPTIONAL */
1057 int *deleteOperationStatus;
1059 Z_ListStatus **deleteListStatuses; /* OPTIONAL */
1060 int *numberNotDeleted; /* OPTIONAL */
1061 int num_bulkStatuses;
1062 Z_ListStatus **bulkStatuses; /* OPTIONAL */
1063 char *deleteMessage; /* OPTIONAL */
1065 Z_OtherInformation *otherInfo;
1067 } Z_DeleteResultSetResponse;
1069 /* ------------------------ CLOSE SERVICE ------------------- */
1071 typedef struct Z_Close
1073 Z_ReferenceId *referenceId; /* OPTIONAL */
1075 #define Z_Close_finished 0
1076 #define Z_Close_shutdown 1
1077 #define Z_Close_systemProblem 2
1078 #define Z_Close_costLimit 3
1079 #define Z_Close_resources 4
1080 #define Z_Close_securityViolation 5
1081 #define Z_Close_protocolError 6
1082 #define Z_Close_lackOfActivity 7
1083 #define Z_Close_peerAbort 8
1084 #define Z_Close_unspecified 9
1085 char *diagnosticInformation; /* OPTIONAL */
1086 Odr_oid *resourceReportFormat; /* OPTIONAL */
1087 Z_External *resourceReport; /* OPTIONAL */
1089 Z_OtherInformation *otherInfo; /* OPTIONAL */
1093 /* ------------------------ SEGMENTATION -------------------- */
1095 typedef struct Z_Segment
1097 Z_ReferenceId *referenceId; /* OPTIONAL */
1098 int *numberOfRecordsReturned;
1099 int num_segmentRecords;
1100 Z_NamePlusRecord **segmentRecords;
1101 Z_OtherInformation *otherInfo; /* OPTIONAL */
1104 /* ----------------------- Extended Services ---------------- */
1106 typedef struct Z_Permissions
1109 int num_allowableFunctions;
1110 int **allowableFunctions;
1111 #define Z_Permissions_delete 1
1112 #define Z_Permissions_modifyContents 2
1113 #define Z_Permissions_modifyPermissions 3
1114 #define Z_Permissions_present 4
1115 #define Z_Permissions_invoke 5
1118 typedef struct Z_ExtendedServicesRequest
1120 Z_ReferenceId *referenceId; /* OPTIONAL */
1122 #define Z_ExtendedServicesRequest_create 1
1123 #define Z_ExtendedServicesRequest_delete 2
1124 #define Z_ExtendedServicesRequest_modify 3
1125 Odr_oid *packageType;
1126 char *packageName; /* OPTIONAL */
1127 char *userId; /* OPTIONAL */
1128 Z_IntUnit *retentionTime; /* OPTIONAL */
1129 Z_Permissions *permissions; /* OPTIONAL */
1130 char *description; /* OPTIONAL */
1131 Z_External *taskSpecificParameters; /* OPTIONAL */
1133 #define Z_ExtendedServicesRequest_wait 1
1134 #define Z_ExtendedServicesRequest_waitIfPossible 2
1135 #define Z_ExtendedServicesRequest_dontWait 3
1136 #define Z_ExtendedServicesRequest_dontReturnPackage 4
1137 char *elements; /* OPTIONAL */
1138 Z_OtherInformation *otherInfo; /* OPTIONAL */
1139 } Z_ExtendedServicesRequest;
1141 typedef struct Z_ExtendedServicesResponse
1143 Z_ReferenceId *referenceId; /* OPTIONAL */
1144 int *operationStatus;
1145 #define Z_ExtendedServicesResponse_done 1
1146 #define Z_ExtendedServicesResponse_accepted 2
1147 #define Z_ExtendedServicesResponse_failure 3
1148 int num_diagnostics;
1149 Z_DiagRec **diagnostics; /* OPTIONAL */
1150 Z_External *taskPackage; /* OPTIONAL */
1151 Z_OtherInformation *otherInfo; /* OPTIONAL */
1152 } Z_ExtendedServicesResponse;
1154 /* ------------------------ Sort --------------------------- */
1156 typedef struct Z_SortAttributes
1159 Z_AttributeList *list;
1162 typedef struct Z_SortKey
1165 #define Z_SortKey_sortField 0
1166 #define Z_SortKey_elementSpec 1
1167 #define Z_SortKey_sortAttributes 2
1171 Z_Specification *elementSpec;
1172 Z_SortAttributes *sortAttributes;
1176 typedef struct Z_SortDbSpecific
1182 typedef struct Z_SortDbSpecificList
1185 Z_SortDbSpecific **dbSpecific;
1186 } Z_SortDbSpecificList;
1188 typedef struct Z_SortElement
1191 #define Z_SortElement_generic 0
1192 #define Z_SortElement_databaseSpecific 1
1196 Z_SortDbSpecificList *databaseSpecific;
1200 typedef struct Z_SortMissingValueAction
1203 #define Z_SortMissingValAct_abort 0
1204 #define Z_SortMissingValAct_null 1
1205 #define Z_SortMissingValAct_valData 2
1212 } Z_SortMissingValueAction;
1214 typedef struct Z_SortKeySpec
1216 Z_SortElement *sortElement;
1218 #define Z_SortRelation_ascending 0
1219 #define Z_SortRelation_descending 1
1220 #define Z_SortRelation_ascendingByFreq 3
1221 #define Z_SortRelation_descendingByFreq 4
1222 int *caseSensitivity;
1223 #define Z_SortCase_caseSensitive 0
1224 #define Z_SortCase_caseInsensitive 1
1225 Z_SortMissingValueAction *missingValueAction; /* OPTIONAL */
1228 typedef struct Z_SortResponse
1230 Z_ReferenceId *referenceId; /* OPTIONAL */
1232 #define Z_SortStatus_success 0
1233 #define Z_SortStatus_partial_1 1
1234 #define Z_SortStatus_failure 2
1235 int *resultSetStatus; /* OPTIONAL */
1236 #define Z_SortResultSetStatus_empty 1
1237 #define Z_SortResultSetStatus_interim 2
1238 #define Z_SortResultSetStatus_unchanged 3
1239 #define Z_SortResultSetStatus_none 4
1240 Z_DiagRecs *diagnostics; /* OPTIONAL */
1241 Z_OtherInformation *otherInfo; /* OPTIONAL */
1244 typedef struct Z_SortKeySpecList
1247 Z_SortKeySpec **specs;
1248 } Z_SortKeySpecList;
1250 typedef struct Z_SortRequest
1252 Z_ReferenceId *referenceId; /* OPTIONAL */
1253 Z_StringList *inputResultSetNames;
1254 char *sortedResultSetName;
1255 Z_SortKeySpecList *sortSequence;
1256 Z_OtherInformation *otherInfo; /* OPTIONAL */
1259 /* ----------------------- Resource Report ------------------ */
1261 typedef struct Z_ResourceReportRequest
1263 Z_ReferenceId *referenceId; /* OPTIONAL */
1264 Z_ReferenceId *opId; /* OPTIONAL */
1265 Odr_oid *prefResourceReportFormat; /* OPTIONAL */
1266 Z_OtherInformation *otherInfo; /* OPTIONAL */
1267 } Z_ResourceReportRequest;
1269 typedef struct Z_ResourceReportResponse
1271 Z_ReferenceId *referenceId; /* OPTIONAL */
1272 int *resourceReportStatus;
1273 #define Z_ResourceReportStatus_success 0
1274 #define Z_ResourceReportStatus_partial 1
1275 #define Z_ResourceReportStatus_failure_1 2
1276 #define Z_ResourceReportStatus_failure_2 3
1277 #define Z_ResourceReportStatus_failure_3 4
1278 #define Z_ResourceReportStatus_failure_4 5
1279 #define Z_ResourceReportStatus_failure_5 6
1280 #define Z_ResourceReportStatus_failure_6 7
1281 Z_External *resourceReport; /* OPTIONAL */
1282 Z_OtherInformation *otherInfo; /* OPTIONAL */
1283 } Z_ResourceReportResponse;
1285 /* ------------------------ APDU ---------------------------- */
1287 typedef struct Z_APDU
1290 #define Z_APDU_initRequest 0
1291 #define Z_APDU_initResponse 1
1292 #define Z_APDU_searchRequest 2
1293 #define Z_APDU_searchResponse 3
1294 #define Z_APDU_presentRequest 4
1295 #define Z_APDU_presentResponse 5
1296 #define Z_APDU_deleteResultSetRequest 6
1297 #define Z_APDU_deleteResultSetResponse 7
1298 #define Z_APDU_resourceControlRequest 8
1299 #define Z_APDU_resourceControlResponse 9
1300 #define Z_APDU_triggerResourceControlRequest 10
1301 #define Z_APDU_scanRequest 11
1302 #define Z_APDU_scanResponse 12
1303 #define Z_APDU_segmentRequest 13
1304 #define Z_APDU_extendedServicesRequest 14
1305 #define Z_APDU_extendedServicesResponse 15
1306 #define Z_APDU_close 16
1307 #define Z_APDU_accessControlRequest 17
1308 #define Z_APDU_accessControlResponse 18
1309 #define Z_APDU_sortRequest 20
1310 #define Z_APDU_sortResponse 21
1311 #define Z_APDU_resourceReportRequest 22
1312 #define Z_APDU_resourceReportResponse 23
1315 Z_InitRequest *initRequest;
1316 Z_InitResponse *initResponse;
1317 Z_SearchRequest *searchRequest;
1318 Z_SearchResponse *searchResponse;
1319 Z_PresentRequest *presentRequest;
1320 Z_PresentResponse *presentResponse;
1321 Z_DeleteResultSetRequest *deleteResultSetRequest;
1322 Z_DeleteResultSetResponse *deleteResultSetResponse;
1323 Z_AccessControlRequest *accessControlRequest;
1324 Z_AccessControlResponse *accessControlResponse;
1325 Z_ResourceControlRequest *resourceControlRequest;
1326 Z_ResourceControlResponse *resourceControlResponse;
1327 Z_TriggerResourceControlRequest *triggerResourceControlRequest;
1328 Z_ResourceReportRequest *resourceReportRequest;
1329 Z_ResourceReportResponse *resourceReportResponse;
1330 Z_ScanRequest *scanRequest;
1331 Z_ScanResponse *scanResponse;
1332 Z_SortRequest *sortRequest;
1333 Z_SortResponse *sortResponse;
1334 Z_Segment *segmentRequest;
1335 Z_ExtendedServicesRequest *extendedServicesRequest;
1336 Z_ExtendedServicesResponse *extendedServicesResponse;
1341 YAZ_EXPORT int z_APDU(ODR o, Z_APDU **p, int opt);
1342 YAZ_EXPORT int z_SUTRS(ODR o, Odr_oct **p, int opt);
1344 YAZ_EXPORT Z_InitRequest *zget_InitRequest(ODR o);
1345 YAZ_EXPORT Z_InitResponse *zget_InitResponse(ODR o);
1346 YAZ_EXPORT Z_SearchRequest *zget_SearchRequest(ODR o);
1347 YAZ_EXPORT Z_SearchResponse *zget_SearchResponse(ODR o);
1348 YAZ_EXPORT Z_PresentRequest *zget_PresentRequest(ODR o);
1349 YAZ_EXPORT Z_PresentResponse *zget_PresentResponse(ODR o);
1350 YAZ_EXPORT Z_DeleteResultSetRequest *zget_DeleteResultSetRequest(ODR o);
1351 YAZ_EXPORT Z_DeleteResultSetResponse *zget_DeleteResultSetResponse(ODR o);
1352 YAZ_EXPORT Z_ScanRequest *zget_ScanRequest(ODR o);
1353 YAZ_EXPORT Z_ScanResponse *zget_ScanResponse(ODR o);
1354 YAZ_EXPORT Z_TriggerResourceControlRequest *zget_TriggerResourceControlRequest(ODR o);
1355 YAZ_EXPORT Z_ResourceControlRequest *zget_ResourceControlRequest(ODR o);
1356 YAZ_EXPORT Z_ResourceControlResponse *zget_ResourceControlResponse(ODR o);
1357 YAZ_EXPORT Z_Close *zget_Close(ODR o);
1358 YAZ_EXPORT int z_StringList(ODR o, Z_StringList **p, int opt);
1359 YAZ_EXPORT int z_InternationalString(ODR o, char **p, int opt);
1360 YAZ_EXPORT int z_OtherInformation(ODR o, Z_OtherInformation **p, int opt);
1361 YAZ_EXPORT int z_ElementSetName(ODR o, char **p, int opt);
1362 YAZ_EXPORT int z_IntUnit(ODR o, Z_IntUnit **p, int opt);
1363 YAZ_EXPORT int z_Unit(ODR o, Z_Unit **p, int opt);
1364 YAZ_EXPORT int z_DatabaseName(ODR o, Z_DatabaseName **p, int opt);
1365 YAZ_EXPORT int z_StringOrNumeric(ODR o, Z_StringOrNumeric **p, int opt);
1366 YAZ_EXPORT int z_OtherInformationUnit(ODR o, Z_OtherInformationUnit **p, int opt);
1367 YAZ_EXPORT int z_Term(ODR o, Z_Term **p, int opt);
1368 YAZ_EXPORT int z_Specification(ODR o, Z_Specification **p, int opt);
1369 YAZ_EXPORT int z_Permissions(ODR o, Z_Permissions **p, int opt);
1370 YAZ_EXPORT int z_DiagRec(ODR o, Z_DiagRec **p, int opt);
1371 YAZ_EXPORT int z_DiagRecs(ODR o, Z_DiagRecs **p, int opt);
1372 YAZ_EXPORT int z_AttributeList(ODR o, Z_AttributeList **p, int opt);
1373 YAZ_EXPORT int z_DefaultDiagFormat(ODR o, Z_DefaultDiagFormat **p, int opt);
1374 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
1375 YAZ_EXPORT int z_Query(ODR o, Z_Query **p, int opt);
1381 #include <prt-rsc.h>
1382 #include <prt-acc.h>
1383 #include <prt-exp.h>
1384 #include <prt-grs.h>
1385 #include <prt-arc.h>
1386 #include <prt-exd.h>
1387 #include <prt-dia.h>
1388 #include <prt-esp.h>
1389 #include <prt-add.h>
1391 #include <prt-ext.h>
1392 #include <prt-dat.h>
1393 #include <prt-univ.h>