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.43 1998-03-31 11:07:45 adam
28 * Furhter work on UNIverse resource report.
29 * Added Extended Services handling in frontend server.
31 * Revision 1.42 1998/03/20 14:46:06 adam
32 * Added UNIverse Resource Reports.
34 * Revision 1.41 1998/02/10 15:31:52 adam
35 * Implemented date and time structure. Changed the Update Extended
38 * Revision 1.40 1997/09/01 08:49:50 adam
39 * New windows NT/95 port using MSV5.0. To export DLL functions the
40 * YAZ_EXPORT modifier was added. Defined in yconfig.h.
42 * Revision 1.39 1997/05/14 06:53:44 adam
45 * Revision 1.38 1997/04/30 08:52:09 quinn
48 * Revision 1.37 1996/10/09 15:54:58 quinn
49 * Added SearchInfoReport
51 * Revision 1.36 1996/10/07 15:29:20 quinn
54 * Revision 1.35 1996/06/10 08:57:38 quinn
55 * Added OPAC, ResourceReport
57 * Revision 1.34 1996/06/10 08:55:36 quinn
60 * Revision 1.33 1996/02/23 10:00:51 quinn
63 * Revision 1.32 1996/02/20 12:52:39 quinn
66 * Revision 1.31 1996/01/22 09:46:45 quinn
67 * Added Sort PDU. Moved StringList to main protocol file.
69 * Revision 1.30 1996/01/10 15:21:32 quinn
70 * Added links to access control PDUs
72 * Revision 1.29 1996/01/02 11:46:49 quinn
73 * Changed 'operator' to 'roperator' to avoid C++ conflict.
76 * Revision 1.28 1996/01/02 08:57:32 quinn
77 * Changed enums in the ASN.1 .h files to #defines. Changed oident.class to oclass
79 * Revision 1.27 1995/10/12 10:34:46 quinn
82 * Revision 1.26 1995/09/29 17:12:08 quinn
85 * Revision 1.25 1995/09/27 15:02:49 quinn
86 * Modified function heads & prototypes.
88 * Revision 1.24 1995/08/29 11:17:43 quinn
89 * *** empty log message ***
91 * Revision 1.23 1995/08/21 09:10:36 quinn
92 * Smallish fixes to suppport new formats.
94 * Revision 1.22 1995/08/17 12:45:14 quinn
95 * Fixed minor problems with GRS-1. Added support in c&s.
97 * Revision 1.21 1995/08/15 12:00:11 quinn
100 * Revision 1.20 1995/08/10 08:54:35 quinn
103 * Revision 1.19 1995/06/19 12:38:28 quinn
104 * Reorganized include-files. Added small features.
106 * Revision 1.18 1995/06/16 13:16:05 quinn
107 * Fixed Defaultdiagformat.
109 * Revision 1.17 1995/06/15 15:42:05 quinn
112 * Revision 1.16 1995/06/15 07:45:06 quinn
115 * Revision 1.15 1995/06/14 15:26:43 quinn
116 * *** empty log message ***
118 * Revision 1.14 1995/06/07 14:42:34 quinn
121 * Revision 1.13 1995/06/07 14:36:47 quinn
124 * Revision 1.12 1995/06/05 10:53:13 quinn
127 * Revision 1.11 1995/06/02 09:49:47 quinn
130 * Revision 1.10 1995/05/29 08:11:34 quinn
131 * Moved oid from odr/asn to util.
133 * Revision 1.9 1995/05/22 11:31:25 quinn
136 * Revision 1.8 1995/05/17 08:41:35 quinn
137 * Added delete to proto & other little things.
138 * Relaying auth info to backend.
140 * Revision 1.7 1995/05/16 08:50:37 quinn
141 * License, documentation, and memory fixes
143 * Revision 1.6 1995/05/15 11:55:55 quinn
144 * Work on asynchronous activity.
146 * Revision 1.5 1995/04/17 11:28:18 quinn
149 * Revision 1.4 1995/04/10 10:22:47 quinn
152 * Revision 1.3 1995/03/30 12:18:09 quinn
155 * Revision 1.2 1995/03/30 10:26:48 quinn
156 * Added Term structure
158 * Revision 1.1 1995/03/30 09:39:42 quinn
159 * Moved .h files to include directory
161 * Revision 1.11 1995/03/30 09:08:44 quinn
162 * Added Resource control protocol
164 * Revision 1.10 1995/03/29 15:39:39 quinn
165 * Adding some resource control elements, and a null-check to getentbyoid
167 * Revision 1.9 1995/03/29 08:06:18 quinn
168 * Added a few v3 elements
170 * Revision 1.8 1995/03/22 10:12:49 quinn
171 * Added Z_PRES constants.
173 * Revision 1.7 1995/03/20 09:45:12 quinn
176 * Revision 1.5 1995/03/07 16:29:34 quinn
177 * Added authentication stuff.
179 * Revision 1.4 1995/03/07 10:13:00 quinn
180 * Added prototype for z_APDU()
182 * Revision 1.3 1995/02/14 11:54:23 quinn
185 * Revision 1.2 1995/02/09 15:51:40 quinn
188 * Revision 1.1 1995/02/06 16:44:48 quinn
189 * First hack at Z/SR protocol
200 #include <yaz-version.h>
207 * Because we didn't have time to put all of the extra v3 elements in here
208 * before the first applications were written, we have to place them
209 * in #ifdefs in places where they would break existing code. If you are
210 * developing new stuff, we urge you to leave them in, even if you don't
211 * intend to use any v3 features. When we are comfortable that the old
212 * apps have been updated, we'll remove the #ifdefs.
217 /* ----------------- GLOBAL AUXILIARY DEFS ----------------*/
220 typedef struct Z_External Z_External;
222 typedef Odr_oct Z_ReferenceId;
223 typedef char Z_DatabaseName;
224 typedef char Z_ResultSetId;
225 typedef Odr_oct Z_ResultsetId;
227 typedef struct Z_InfoCategory
229 Odr_oid *categoryTypeId; /* OPTIONAL */
233 typedef struct Z_OtherInformationUnit
235 Z_InfoCategory *category; /* OPTIONAL */
237 #define Z_OtherInfo_characterInfo 0
238 #define Z_OtherInfo_binaryInfo 1
239 #define Z_OtherInfo_externallyDefinedInfo 2
240 #define Z_OtherInfo_oid 3
245 Z_External *externallyDefinedInfo;
248 } Z_OtherInformationUnit;
250 typedef struct Z_OtherInformation
253 Z_OtherInformationUnit **list;
254 } Z_OtherInformation;
256 typedef struct Z_StringOrNumeric
259 #define Z_StringOrNumeric_string 0
260 #define Z_StringOrNumeric_numeric 1
268 typedef struct Z_Unit
270 char *unitSystem; /* OPTIONAL */
271 Z_StringOrNumeric *unitType; /* OPTIONAL */
272 Z_StringOrNumeric *unit; /* OPTIONAL */
273 int *scaleFactor; /* OPTIONAL */
276 typedef struct Z_IntUnit
282 typedef Odr_oct Z_SUTRS;
284 typedef struct Z_StringList
290 /* ----------------- INIT SERVICE ----------------*/
294 char *groupId; /* OPTIONAL */
295 char *userId; /* OPTIONAL */
296 char *password; /* OPTIONAL */
299 typedef struct Z_IdAuthentication
302 #define Z_IdAuthentication_open 0
303 #define Z_IdAuthentication_idPass 1
304 #define Z_IdAuthentication_anonymous 2
305 #define Z_IdAuthentication_other 3
313 } Z_IdAuthentication;
315 #define Z_ProtocolVersion_1 0
316 #define Z_ProtocolVersion_2 1
317 #define Z_ProtocolVersion_3 2
319 #define Z_Options_search 0
320 #define Z_Options_present 1
321 #define Z_Options_delSet 2
322 #define Z_Options_resourceReport 3
323 #define Z_Options_triggerResourceCtrl 4
324 #define Z_Options_resourceCtrl 5
325 #define Z_Options_accessCtrl 6
326 #define Z_Options_scan 7
327 #define Z_Options_sort 8
328 #define Z_Options_reserved 9
329 #define Z_Options_extendedServices 10
330 #define Z_Options_level_1Segmentation 11
331 #define Z_Options_level_2Segmentation 12
332 #define Z_Options_concurrentOperations 13
333 #define Z_Options_namedResultSets 14
335 typedef struct Z_InitRequest
337 Z_ReferenceId *referenceId; /* OPTIONAL */
338 Odr_bitmask *protocolVersion;
339 Odr_bitmask *options;
340 int *preferredMessageSize;
341 int *maximumRecordSize;
342 Z_IdAuthentication* idAuthentication; /* OPTIONAL */
343 char *implementationId; /* OPTIONAL */
344 char *implementationName; /* OPTIONAL */
345 char *implementationVersion; /* OPTIONAL */
346 Z_External *userInformationField; /* OPTIONAL */
348 Z_OtherInformation *otherInfo; /* OPTIONAL */
352 typedef struct Z_InitResponse
354 Z_ReferenceId *referenceId; /* OPTIONAL */
355 Odr_bitmask *protocolVersion;
356 Odr_bitmask *options;
357 int *preferredMessageSize;
358 int *maximumRecordSize;
360 char *implementationId; /* OPTIONAL */
361 char *implementationName; /* OPTIONAL */
362 char *implementationVersion; /* OPTIONAL */
363 Z_External *userInformationField; /* OPTIONAL */
365 Z_OtherInformation *otherInfo; /* OPTIONAL */
369 typedef struct Z_NSRAuthentication
374 } Z_NSRAuthentication;
376 int z_NSRAuthentication(ODR o, Z_NSRAuthentication **p, int opt);
378 int z_StrAuthentication(ODR o, char **p, int opt);
380 /* ------------------ SEARCH SERVICE ----------------*/
382 typedef struct Z_DatabaseSpecificUnit
385 char *elementSetName;
386 } Z_DatabaseSpecificUnit;
388 typedef struct Z_DatabaseSpecific
391 Z_DatabaseSpecificUnit **elements;
392 } Z_DatabaseSpecific;
394 typedef struct Z_ElementSetNames
397 #define Z_ElementSetNames_generic 0
398 #define Z_ElementSetNames_databaseSpecific 1
402 Z_DatabaseSpecific *databaseSpecific;
406 /* ---------------------- RPN QUERY --------------------------- */
408 typedef struct Z_ComplexAttribute
411 Z_StringOrNumeric **list;
412 int num_semanticAction;
413 int **semanticAction; /* OPTIONAL */
414 } Z_ComplexAttribute;
416 typedef struct Z_AttributeElement
419 Odr_oid *attributeSet; /* OPTIONAL - v3 only */
424 #define Z_AttributeValue_numeric 0
425 #define Z_AttributeValue_complex 1
429 Z_ComplexAttribute *complex;
434 } Z_AttributeElement;
436 typedef struct Z_Term
439 #define Z_Term_general 0
440 #define Z_Term_numeric 1
441 #define Z_Term_characterString 2
443 #define Z_Term_dateTime 4
444 #define Z_Term_external 5
445 #define Z_Term_integerAndUnit 6
446 #define Z_Term_null 7
449 Odr_oct *general; /* this is required for v2 */
451 char *characterString;
454 Z_External *external;
455 /* Z_IntUnit *integerAndUnit; */
460 typedef struct Z_AttributesPlusTerm
463 Z_AttributeElement **attributeList;
465 } Z_AttributesPlusTerm;
467 typedef struct Z_ResultSetPlusAttributes
471 Z_AttributeElement **attributeList;
472 } Z_ResultSetPlusAttributes;
474 typedef struct Z_ProximityOperator
476 bool_t *exclusion; /* OPTIONAL */
480 #define Z_Prox_lessThan 1
481 #define Z_Prox_lessThanOrEqual 2
482 #define Z_Prox_equal 3
483 #define Z_Prox_greaterThanOrEqual 4
484 #define Z_Prox_greaterThan 5
485 #define Z_Prox_notEqual 6
487 #define Z_ProxCode_known 0
488 #define Z_ProxCode_private 1
489 int *proximityUnitCode;
490 #define Z_ProxUnit_character 1
491 #define Z_ProxUnit_word 2
492 #define Z_ProxUnit_sentence 3
493 #define Z_ProxUnit_paragraph 4
494 #define Z_ProxUnit_section 5
495 #define Z_ProxUnit_chapter 6
496 #define Z_ProxUnit_document 7
497 #define Z_ProxUnit_element 8
498 #define Z_ProxUnit_subelement 9
499 #define Z_ProxUnit_elementType 10
500 #define Z_ProxUnit_byte 11 /* v3 only */
501 } Z_ProximityOperator;
503 typedef struct Z_Operator
506 #define Z_Operator_and 0
507 #define Z_Operator_or 1
508 #define Z_Operator_and_not 2
509 #define Z_Operator_prox 3
512 Odr_null *and; /* these guys are nulls. */
515 Z_ProximityOperator *prox;
519 typedef struct Z_Operand
522 #define Z_Operand_APT 0
523 #define Z_Operand_resultSetId 1
524 #define Z_Operand_resultAttr /* v3 only */ 2
527 Z_AttributesPlusTerm *attributesPlusTerm;
528 Z_ResultSetId *resultSetId;
529 Z_ResultSetPlusAttributes *resultAttr;
533 typedef struct Z_Complex
535 struct Z_RPNStructure *s1;
536 struct Z_RPNStructure *s2;
537 Z_Operator *roperator;
540 typedef struct Z_RPNStructure
543 #define Z_RPNStructure_simple 0
544 #define Z_RPNStructure_complex 1
552 typedef struct Z_RPNQuery
554 Odr_oid *attributeSetId;
555 Z_RPNStructure *RPNStructure;
558 /* -------------------------- SEARCHREQUEST -------------------------- */
560 typedef struct Z_Query
563 #define Z_Query_type_1 1
564 #define Z_Query_type_2 2
565 #define Z_Query_type_101 3
570 Z_RPNQuery *type_101;
574 typedef struct Z_SearchRequest
576 Z_ReferenceId *referenceId; /* OPTIONAL */
577 int *smallSetUpperBound;
578 int *largeSetLowerBound;
579 int *mediumSetPresentNumber;
580 bool_t *replaceIndicator;
582 int num_databaseNames;
583 char **databaseNames;
584 Z_ElementSetNames *smallSetElementSetNames; /* OPTIONAL */
585 Z_ElementSetNames *mediumSetElementSetNames; /* OPTIONAL */
586 Odr_oid *preferredRecordSyntax; /* OPTIONAL */
589 Z_OtherInformation *additionalSearchInfo; /* OPTIONAL */
590 Z_OtherInformation *otherInfo; /* OPTIONAL */
594 /* ------------------------ RECORD -------------------------- */
596 typedef Z_External Z_DatabaseRecord;
600 typedef struct Z_DefaultDiagFormat
602 Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
604 /* until the whole character set issue becomes more definite,
605 * you can probably ignore this on input. */
607 #define Z_DiagForm_v2AddInfo 0
608 #define Z_DiagForm_v3AddInfo 1
610 } Z_DefaultDiagFormat;
612 typedef struct Z_DiagRec
615 #define Z_DiagRec_defaultFormat 0
616 #define Z_DiagRec_externallyDefined 1
619 Z_DefaultDiagFormat *defaultFormat;
620 Z_External *externallyDefined;
626 typedef struct Z_DiagRec
628 Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
635 typedef struct Z_DiagRecs
638 Z_DiagRec **diagRecs;
641 typedef struct Z_NamePlusRecord
643 char *databaseName; /* OPTIONAL */
645 #define Z_NamePlusRecord_databaseRecord 0
646 #define Z_NamePlusRecord_surrogateDiagnostic 1
649 Z_DatabaseRecord *databaseRecord;
650 Z_DiagRec *surrogateDiagnostic;
654 typedef struct Z_NamePlusRecordList
657 Z_NamePlusRecord **records;
658 } Z_NamePlusRecordList;
660 typedef struct Z_Records
663 #define Z_Records_DBOSD 0
664 #define Z_Records_NSD 1
665 #define Z_Records_multipleNSD 2
668 Z_NamePlusRecordList *databaseOrSurDiagnostics;
669 Z_DiagRec *nonSurrogateDiagnostic;
670 Z_DiagRecs *multipleNonSurDiagnostics;
674 /* ------------------------ SEARCHRESPONSE ------------------ */
676 typedef struct Z_SearchResponse
678 Z_ReferenceId *referenceId; /* OPTIONAL */
680 int *numberOfRecordsReturned;
681 int *nextResultSetPosition;
682 bool_t *searchStatus;
683 int *resultSetStatus; /* OPTIONAL */
684 #define Z_RES_SUBSET 1
685 #define Z_RES_INTERIM 2
687 int *presentStatus; /* OPTIONAL */
688 #define Z_PRES_SUCCESS 0
689 #define Z_PRES_PARTIAL_1 1
690 #define Z_PRES_PARTIAL_2 2
691 #define Z_PRES_PARTIAL_3 3
692 #define Z_PRES_PARTIAL_4 4
693 #define Z_PRES_FAILURE 5
694 Z_Records *records; /* OPTIONAL */
696 Z_OtherInformation *additionalSearchInfo;
697 Z_OtherInformation *otherInfo;
701 /* ------------------------- PRESENT SERVICE -----------------*/
703 typedef struct Z_ElementSpec
706 #define Z_ElementSpec_elementSetName 0
707 #define Z_ElementSpec_externalSpec 1
710 char *elementSetName;
711 Z_External *externalSpec;
715 typedef struct Z_Specification
717 Odr_oid *schema; /* OPTIONAL */
718 Z_ElementSpec *elementSpec; /* OPTIONAL */
721 typedef struct Z_DbSpecific
724 Z_Specification *spec;
727 typedef struct Z_CompSpec
729 bool_t *selectAlternativeSyntax;
730 Z_Specification *generic; /* OPTIONAL */
732 Z_DbSpecific **dbSpecific; /* OPTIONAL */
733 int num_recordSyntax;
734 Odr_oid **recordSyntax; /* OPTIONAL */
737 typedef struct Z_RecordComposition
740 #define Z_RecordComp_simple 0
741 #define Z_RecordComp_complex 1
744 Z_ElementSetNames *simple;
747 } Z_RecordComposition;
749 typedef struct Z_Range
751 int *startingPosition;
752 int *numberOfRecords;
755 typedef struct Z_PresentRequest
757 Z_ReferenceId *referenceId; /* OPTIONAL */
758 Z_ResultSetId *resultSetId;
759 int *resultSetStartPoint;
760 int *numberOfRecordsRequested;
763 Z_Range **additionalRanges; /* OPTIONAL */
764 Z_RecordComposition *recordComposition; /* OPTIONAL */
766 Z_ElementSetNames *elementSetNames; /* OPTIONAL */
768 Odr_oid *preferredRecordSyntax; /* OPTIONAL */
770 int *maxSegmentCount; /* OPTIONAL */
771 int *maxRecordSize; /* OPTIONAL */
772 int *maxSegmentSize; /* OPTIONAL */
773 Z_OtherInformation *otherInfo; /* OPTIONAL */
777 typedef struct Z_PresentResponse
779 Z_ReferenceId *referenceId; /* OPTIONAL */
780 int *numberOfRecordsReturned;
781 int *nextResultSetPosition;
785 Z_OtherInformation *otherInfo; /* OPTIONAL */
789 /* ------------------ RESOURCE CONTROL ----------------*/
791 typedef struct Z_TriggerResourceControlRequest
793 Z_ReferenceId *referenceId; /* OPTIONAL */
794 int *requestedAction;
795 #define Z_TriggerResourceCtrl_resourceReport 1
796 #define Z_TriggerResourceCtrl_resourceControl 2
797 #define Z_TriggerResourceCtrl_cancel 3
798 Odr_oid *prefResourceReportFormat; /* OPTIONAL */
799 bool_t *resultSetWanted; /* OPTIONAL */
801 Z_OtherInformation *otherInfo;
803 } Z_TriggerResourceControlRequest;
805 typedef struct Z_ResourceControlRequest
807 Z_ReferenceId *referenceId; /* OPTIONAL */
808 bool_t *suspendedFlag; /* OPTIONAL */
809 Z_External *resourceReport; /* OPTIONAL */
810 int *partialResultsAvailable; /* OPTIONAL */
811 #define Z_ResourceControlRequest_subset 1
812 #define Z_ResourceControlRequest_interim 2
813 #define Z_ResourceControlRequest_none 3
814 bool_t *responseRequired;
815 bool_t *triggeredRequestFlag; /* OPTIONAL */
817 Z_OtherInformation *otherInfo;
819 } Z_ResourceControlRequest;
821 typedef struct Z_ResourceControlResponse
823 Z_ReferenceId *referenceId; /* OPTIONAL */
824 bool_t *continueFlag;
825 bool_t *resultSetWanted; /* OPTIONAL */
827 Z_OtherInformation *otherInfo;
829 } Z_ResourceControlResponse;
832 /* ------------------ ACCESS CTRL SERVICE ----------------*/
834 typedef struct Z_AccessControlRequest
836 Z_ReferenceId *referenceId; /* OPTIONAL */
838 #define Z_AccessRequest_simpleForm 0
839 #define Z_AccessRequest_externallyDefined 1
843 Z_External *externallyDefined;
846 Z_OtherInformation *otherInfo; /* OPTIONAL */
848 } Z_AccessControlRequest;
850 typedef struct Z_AccessControlResponse
852 Z_ReferenceId *referenceId; /* OPTIONAL */
854 #define Z_AccessResponse_simpleForm 0
855 #define Z_AccessResponse_externallyDefined 1
859 Z_External *externallyDefined;
861 Z_DiagRec *diagnostic; /* OPTIONAL */
863 Z_OtherInformation *otherInfo; /* OPTIONAL */
865 } Z_AccessControlResponse;
867 /* ------------------------ SCAN SERVICE -------------------- */
869 typedef struct Z_AttributeList
872 Z_AttributeElement **attributes;
875 typedef struct Z_AlternativeTerm
878 Z_AttributesPlusTerm **terms;
883 typedef struct Z_ByDatabase
886 int *num; /* OPTIONAL */
887 Z_OtherInformation *otherDbInfo; /* OPTIONAL */
890 typedef struct Z_ByDatabaseList
893 Z_ByDatabase **elements;
896 typedef struct Z_ScanOccurrences
899 #define Z_ScanOccurrences_global 0
900 #define Z_ScanOccurrences_byDatabase 1
904 Z_ByDatabaseList *byDatabase;
909 typedef struct Z_OccurrenceByAttributesElem
911 Z_AttributeList *attributes;
912 Z_ScanOccurrences *occurrences; /* OPTIONAL */
913 Z_OtherInformation *otherOccurInfo; /* OPTIONAL */
914 } Z_OccurrenceByAttributesElem;
916 typedef struct Z_OccurrenceByAttributes
919 Z_OccurrenceByAttributesElem **elements;
920 } Z_OccurrenceByAttributes;
925 * Old, incomplete definition of OccurrenceByAttributes.
928 typedef struct Z_OccurrenceByAttributes
930 Z_AttributeList *attributes;
933 #define Z_OByAtt_global 0
934 #define Z_ObyAtt_byDatabase 1
940 /* Z_ByDatabase *byDatabase; */
943 } Z_OccurrenceByAttributes;
947 typedef struct Z_TermInfo
950 char *displayTerm; /* OPTIONAL */
951 Z_AttributeList *suggestedAttributes; /* OPTIONAL */
952 Z_AlternativeTerm *alternativeTerm; /* OPTIONAL */
953 int *globalOccurrences; /* OPTIONAL */
954 Z_OccurrenceByAttributes *byAttributes; /* OPTIONAL */
955 Z_OtherInformation *otherTermInfo; /* OPTIONAL */
958 typedef struct Z_Entry
961 #define Z_Entry_termInfo 0
962 #define Z_Entry_surrogateDiagnostic 1
965 Z_TermInfo *termInfo;
966 Z_DiagRec *surrogateDiagnostic;
970 typedef struct Z_Entries
976 typedef struct Z_ListEntries
979 #define Z_ListEntries_entries 0
980 #define Z_ListEntries_nonSurrogateDiagnostics 1
984 Z_DiagRecs *nonSurrogateDiagnostics;
988 typedef struct Z_ScanRequest
990 Z_ReferenceId *referenceId; /* OPTIONAL */
991 int num_databaseNames;
992 char **databaseNames;
993 Odr_oid *attributeSet; /* OPTIONAL */
994 Z_AttributesPlusTerm *termListAndStartPoint;
995 int *stepSize; /* OPTIONAL */
996 int *numberOfTermsRequested;
997 int *preferredPositionInResponse; /* OPTIONAL */
999 Z_OtherInformation *otherInfo;
1003 typedef struct Z_ScanResponse
1005 Z_ReferenceId *referenceId; /* OPTIONAL */
1006 int *stepSize; /* OPTIONAL */
1008 #define Z_Scan_success 0
1009 #define Z_Scan_partial_1 1
1010 #define Z_Scan_partial_2 2
1011 #define Z_Scan_partial_3 3
1012 #define Z_Scan_partial_4 4
1013 #define Z_Scan_partial_5 5
1014 #define Z_Scan_failure 6
1015 int *numberOfEntriesReturned;
1016 int *positionOfTerm; /* OPTIONAL */
1017 Z_ListEntries *entries; /* OPTIONAL */
1018 Odr_oid *attributeSet; /* OPTIONAL */
1020 Z_OtherInformation *otherInfo;
1025 /* ------------------------ DELETE -------------------------- */
1027 #define Z_DeleteStatus_success 0
1028 #define Z_DeleteStatus_resultSetDidNotExist 1
1029 #define Z_DeleteStatus_previouslyDeletedByTarget 2
1030 #define Z_DeleteStatus_systemProblemAtTarget 3
1031 #define Z_DeleteStatus_accessNotAllowed 4
1032 #define Z_DeleteStatus_resourceControlAtOrigin 5
1033 #define Z_DeleteStatus_resourceControlAtTarget 6
1034 #define Z_DeleteStatus_bulkDeleteNotSupported 7
1035 #define Z_DeleteStatus_notAllRsltSetsDeletedOnBulkDlte 8
1036 #define Z_DeleteStatus_notAllRequestedResultSetsDeleted 9
1037 #define Z_DeleteStatus_resultSetInUse 10
1039 typedef struct Z_ListStatus
1045 typedef struct Z_DeleteResultSetRequest
1047 Z_ReferenceId *referenceId; /* OPTIONAL */
1048 int *deleteFunction;
1049 #define Z_DeleteRequest_list 0
1050 #define Z_DeleteRequest_all 1
1052 Z_ResultSetId **resultSetList; /* OPTIONAL */
1054 Z_OtherInformation *otherInfo;
1056 } Z_DeleteResultSetRequest;
1058 typedef struct Z_DeleteResultSetResponse
1060 Z_ReferenceId *referenceId; /* OPTIONAL */
1061 int *deleteOperationStatus;
1063 Z_ListStatus **deleteListStatuses; /* OPTIONAL */
1064 int *numberNotDeleted; /* OPTIONAL */
1065 int num_bulkStatuses;
1066 Z_ListStatus **bulkStatuses; /* OPTIONAL */
1067 char *deleteMessage; /* OPTIONAL */
1069 Z_OtherInformation *otherInfo;
1071 } Z_DeleteResultSetResponse;
1073 /* ------------------------ CLOSE SERVICE ------------------- */
1075 typedef struct Z_Close
1077 Z_ReferenceId *referenceId; /* OPTIONAL */
1079 #define Z_Close_finished 0
1080 #define Z_Close_shutdown 1
1081 #define Z_Close_systemProblem 2
1082 #define Z_Close_costLimit 3
1083 #define Z_Close_resources 4
1084 #define Z_Close_securityViolation 5
1085 #define Z_Close_protocolError 6
1086 #define Z_Close_lackOfActivity 7
1087 #define Z_Close_peerAbort 8
1088 #define Z_Close_unspecified 9
1089 char *diagnosticInformation; /* OPTIONAL */
1090 Odr_oid *resourceReportFormat; /* OPTIONAL */
1091 Z_External *resourceReport; /* OPTIONAL */
1093 Z_OtherInformation *otherInfo; /* OPTIONAL */
1097 /* ------------------------ SEGMENTATION -------------------- */
1099 typedef struct Z_Segment
1101 Z_ReferenceId *referenceId; /* OPTIONAL */
1102 int *numberOfRecordsReturned;
1103 int num_segmentRecords;
1104 Z_NamePlusRecord **segmentRecords;
1105 Z_OtherInformation *otherInfo; /* OPTIONAL */
1108 /* ----------------------- Extended Services ---------------- */
1110 typedef struct Z_Permissions
1113 int num_allowableFunctions;
1114 int **allowableFunctions;
1115 #define Z_Permissions_delete 1
1116 #define Z_Permissions_modifyContents 2
1117 #define Z_Permissions_modifyPermissions 3
1118 #define Z_Permissions_present 4
1119 #define Z_Permissions_invoke 5
1122 typedef struct Z_ExtendedServicesRequest
1124 Z_ReferenceId *referenceId; /* OPTIONAL */
1126 #define Z_ExtendedServicesRequest_create 1
1127 #define Z_ExtendedServicesRequest_delete 2
1128 #define Z_ExtendedServicesRequest_modify 3
1129 Odr_oid *packageType;
1130 char *packageName; /* OPTIONAL */
1131 char *userId; /* OPTIONAL */
1132 Z_IntUnit *retentionTime; /* OPTIONAL */
1133 Z_Permissions *permissions; /* OPTIONAL */
1134 char *description; /* OPTIONAL */
1135 Z_External *taskSpecificParameters; /* OPTIONAL */
1137 #define Z_ExtendedServicesRequest_wait 1
1138 #define Z_ExtendedServicesRequest_waitIfPossible 2
1139 #define Z_ExtendedServicesRequest_dontWait 3
1140 #define Z_ExtendedServicesRequest_dontReturnPackage 4
1141 char *elements; /* OPTIONAL */
1142 Z_OtherInformation *otherInfo; /* OPTIONAL */
1143 } Z_ExtendedServicesRequest;
1145 typedef struct Z_ExtendedServicesResponse
1147 Z_ReferenceId *referenceId; /* OPTIONAL */
1148 int *operationStatus;
1149 #define Z_ExtendedServicesResponse_done 1
1150 #define Z_ExtendedServicesResponse_accepted 2
1151 #define Z_ExtendedServicesResponse_failure 3
1152 int num_diagnostics;
1153 Z_DiagRec **diagnostics; /* OPTIONAL */
1154 Z_External *taskPackage; /* OPTIONAL */
1155 Z_OtherInformation *otherInfo; /* OPTIONAL */
1156 } Z_ExtendedServicesResponse;
1158 /* ------------------------ Sort --------------------------- */
1160 typedef struct Z_SortAttributes
1163 Z_AttributeList *list;
1166 typedef struct Z_SortKey
1169 #define Z_SortKey_sortField 0
1170 #define Z_SortKey_elementSpec 1
1171 #define Z_SortKey_sortAttributes 2
1175 Z_Specification *elementSpec;
1176 Z_SortAttributes *sortAttributes;
1180 typedef struct Z_SortDbSpecific
1186 typedef struct Z_SortDbSpecificList
1189 Z_SortDbSpecific **dbSpecific;
1190 } Z_SortDbSpecificList;
1192 typedef struct Z_SortElement
1195 #define Z_SortElement_generic 0
1196 #define Z_SortElement_databaseSpecific 1
1200 Z_SortDbSpecificList *databaseSpecific;
1204 typedef struct Z_SortMissingValueAction
1207 #define Z_SortMissingValAct_abort 0
1208 #define Z_SortMissingValAct_null 1
1209 #define Z_SortMissingValAct_valData 2
1216 } Z_SortMissingValueAction;
1218 typedef struct Z_SortKeySpec
1220 Z_SortElement *sortElement;
1222 #define Z_SortRelation_ascending 0
1223 #define Z_SortRelation_descending 1
1224 #define Z_SortRelation_ascendingByFreq 3
1225 #define Z_SortRelation_descendingByFreq 4
1226 int *caseSensitivity;
1227 #define Z_SortCase_caseSensitive 0
1228 #define Z_SortCase_caseInsensitive 1
1229 Z_SortMissingValueAction *missingValueAction; /* OPTIONAL */
1232 typedef struct Z_SortResponse
1234 Z_ReferenceId *referenceId; /* OPTIONAL */
1236 #define Z_SortStatus_success 0
1237 #define Z_SortStatus_partial_1 1
1238 #define Z_SortStatus_failure 2
1239 int *resultSetStatus; /* OPTIONAL */
1240 #define Z_SortResultSetStatus_empty 1
1241 #define Z_SortResultSetStatus_interim 2
1242 #define Z_SortResultSetStatus_unchanged 3
1243 #define Z_SortResultSetStatus_none 4
1244 Z_DiagRecs *diagnostics; /* OPTIONAL */
1245 Z_OtherInformation *otherInfo; /* OPTIONAL */
1248 typedef struct Z_SortKeySpecList
1251 Z_SortKeySpec **specs;
1252 } Z_SortKeySpecList;
1254 typedef struct Z_SortRequest
1256 Z_ReferenceId *referenceId; /* OPTIONAL */
1257 Z_StringList *inputResultSetNames;
1258 char *sortedResultSetName;
1259 Z_SortKeySpecList *sortSequence;
1260 Z_OtherInformation *otherInfo; /* OPTIONAL */
1263 /* ----------------------- Resource Report ------------------ */
1265 typedef struct Z_ResourceReportRequest
1267 Z_ReferenceId *referenceId; /* OPTIONAL */
1268 Z_ReferenceId *opId; /* OPTIONAL */
1269 Odr_oid *prefResourceReportFormat; /* OPTIONAL */
1270 Z_OtherInformation *otherInfo; /* OPTIONAL */
1271 } Z_ResourceReportRequest;
1273 typedef struct Z_ResourceReportResponse
1275 Z_ReferenceId *referenceId; /* OPTIONAL */
1276 int *resourceReportStatus;
1277 #define Z_ResourceReportStatus_success 0
1278 #define Z_ResourceReportStatus_partial 1
1279 #define Z_ResourceReportStatus_failure_1 2
1280 #define Z_ResourceReportStatus_failure_2 3
1281 #define Z_ResourceReportStatus_failure_3 4
1282 #define Z_ResourceReportStatus_failure_4 5
1283 #define Z_ResourceReportStatus_failure_5 6
1284 #define Z_ResourceReportStatus_failure_6 7
1285 Z_External *resourceReport; /* OPTIONAL */
1286 Z_OtherInformation *otherInfo; /* OPTIONAL */
1287 } Z_ResourceReportResponse;
1289 /* ------------------------ APDU ---------------------------- */
1291 typedef struct Z_APDU
1294 #define Z_APDU_initRequest 0
1295 #define Z_APDU_initResponse 1
1296 #define Z_APDU_searchRequest 2
1297 #define Z_APDU_searchResponse 3
1298 #define Z_APDU_presentRequest 4
1299 #define Z_APDU_presentResponse 5
1300 #define Z_APDU_deleteResultSetRequest 6
1301 #define Z_APDU_deleteResultSetResponse 7
1302 #define Z_APDU_resourceControlRequest 8
1303 #define Z_APDU_resourceControlResponse 9
1304 #define Z_APDU_triggerResourceControlRequest 10
1305 #define Z_APDU_scanRequest 11
1306 #define Z_APDU_scanResponse 12
1307 #define Z_APDU_segmentRequest 13
1308 #define Z_APDU_extendedServicesRequest 14
1309 #define Z_APDU_extendedServicesResponse 15
1310 #define Z_APDU_close 16
1311 #define Z_APDU_accessControlRequest 17
1312 #define Z_APDU_accessControlResponse 18
1313 #define Z_APDU_sortRequest 20
1314 #define Z_APDU_sortResponse 21
1315 #define Z_APDU_resourceReportRequest 22
1316 #define Z_APDU_resourceReportResponse 23
1319 Z_InitRequest *initRequest;
1320 Z_InitResponse *initResponse;
1321 Z_SearchRequest *searchRequest;
1322 Z_SearchResponse *searchResponse;
1323 Z_PresentRequest *presentRequest;
1324 Z_PresentResponse *presentResponse;
1325 Z_DeleteResultSetRequest *deleteResultSetRequest;
1326 Z_DeleteResultSetResponse *deleteResultSetResponse;
1327 Z_AccessControlRequest *accessControlRequest;
1328 Z_AccessControlResponse *accessControlResponse;
1329 Z_ResourceControlRequest *resourceControlRequest;
1330 Z_ResourceControlResponse *resourceControlResponse;
1331 Z_TriggerResourceControlRequest *triggerResourceControlRequest;
1332 Z_ResourceReportRequest *resourceReportRequest;
1333 Z_ResourceReportResponse *resourceReportResponse;
1334 Z_ScanRequest *scanRequest;
1335 Z_ScanResponse *scanResponse;
1336 Z_SortRequest *sortRequest;
1337 Z_SortResponse *sortResponse;
1338 Z_Segment *segmentRequest;
1339 Z_ExtendedServicesRequest *extendedServicesRequest;
1340 Z_ExtendedServicesResponse *extendedServicesResponse;
1345 YAZ_EXPORT int z_APDU(ODR o, Z_APDU **p, int opt);
1346 YAZ_EXPORT int z_SUTRS(ODR o, Odr_oct **p, int opt);
1348 YAZ_EXPORT Z_InitRequest *zget_InitRequest(ODR o);
1349 YAZ_EXPORT Z_InitResponse *zget_InitResponse(ODR o);
1350 YAZ_EXPORT Z_SearchRequest *zget_SearchRequest(ODR o);
1351 YAZ_EXPORT Z_SearchResponse *zget_SearchResponse(ODR o);
1352 YAZ_EXPORT Z_PresentRequest *zget_PresentRequest(ODR o);
1353 YAZ_EXPORT Z_PresentResponse *zget_PresentResponse(ODR o);
1354 YAZ_EXPORT Z_DeleteResultSetRequest *zget_DeleteResultSetRequest(ODR o);
1355 YAZ_EXPORT Z_DeleteResultSetResponse *zget_DeleteResultSetResponse(ODR o);
1356 YAZ_EXPORT Z_ScanRequest *zget_ScanRequest(ODR o);
1357 YAZ_EXPORT Z_ScanResponse *zget_ScanResponse(ODR o);
1358 YAZ_EXPORT Z_TriggerResourceControlRequest *zget_TriggerResourceControlRequest(ODR o);
1359 YAZ_EXPORT Z_ResourceControlRequest *zget_ResourceControlRequest(ODR o);
1360 YAZ_EXPORT Z_ResourceControlResponse *zget_ResourceControlResponse(ODR o);
1361 YAZ_EXPORT Z_Close *zget_Close(ODR o);
1362 YAZ_EXPORT int z_StringList(ODR o, Z_StringList **p, int opt);
1363 YAZ_EXPORT int z_InternationalString(ODR o, char **p, int opt);
1364 YAZ_EXPORT int z_OtherInformation(ODR o, Z_OtherInformation **p, int opt);
1365 YAZ_EXPORT int z_ElementSetName(ODR o, char **p, int opt);
1366 YAZ_EXPORT int z_IntUnit(ODR o, Z_IntUnit **p, int opt);
1367 YAZ_EXPORT int z_Unit(ODR o, Z_Unit **p, int opt);
1368 YAZ_EXPORT int z_DatabaseName(ODR o, Z_DatabaseName **p, int opt);
1369 YAZ_EXPORT int z_StringOrNumeric(ODR o, Z_StringOrNumeric **p, int opt);
1370 YAZ_EXPORT int z_OtherInformationUnit(ODR o, Z_OtherInformationUnit **p, int opt);
1371 YAZ_EXPORT int z_Term(ODR o, Z_Term **p, int opt);
1372 YAZ_EXPORT int z_Specification(ODR o, Z_Specification **p, int opt);
1373 YAZ_EXPORT int z_Permissions(ODR o, Z_Permissions **p, int opt);
1374 YAZ_EXPORT int z_DiagRec(ODR o, Z_DiagRec **p, int opt);
1375 YAZ_EXPORT int z_DiagRecs(ODR o, Z_DiagRecs **p, int opt);
1376 YAZ_EXPORT int z_AttributeList(ODR o, Z_AttributeList **p, int opt);
1377 YAZ_EXPORT int z_DefaultDiagFormat(ODR o, Z_DefaultDiagFormat **p, int opt);
1378 YAZ_EXPORT Z_APDU *zget_APDU(ODR o, int which);
1379 YAZ_EXPORT int z_Query(ODR o, Z_Query **p, int opt);
1385 #include <prt-rsc.h>
1386 #include <prt-acc.h>
1387 #include <prt-exp.h>
1388 #include <prt-grs.h>
1389 #include <prt-arc.h>
1390 #include <prt-exd.h>
1391 #include <prt-dia.h>
1392 #include <prt-esp.h>
1393 #include <prt-add.h>
1395 #include <prt-dat.h>
1396 #include <prt-univ.h>
1397 #include <prt-ext.h>