Print Friendly  .  About this website   .  Search 

 

 

 

Index Data  >  YAZ  >  YAZ User's Guide and Reference  >  PDU Contents Table

PDU Contents Table

We include, for reference, a listing of the fields of each top-level PDU, as well as their default settings.

Table 5.1. Default settings for PDU Initialize Request

Field Type Default Value
referenceId Z_ReferenceId NULL
protocolVersion Odr_bitmask Empty bitmask
options Odr_bitmask Empty bitmask
preferredMessageSize int 30*1024
maximumRecordSize int 30*1024
idAuthentication Z_IdAuthentication NULL
implementationId char* "81"
implementationName char* "YAZ"
implementationVersion char* YAZ_VERSION
userInformationField Z_UserInformation NULL
otherInfo Z_OtherInformation NULL

Table 5.2. Default settings for PDU Initialize Response

Field Type Default Value
referenceId Z_ReferenceId NULL
protocolVersion Odr_bitmask Empty bitmask
options Odr_bitmask Empty bitmask
preferredMessageSize int 30*1024
maximumRecordSize int 30*1024
result bool_t TRUE
implementationId char* "id)"
implementationName char* "YAZ"
implementationVersion char* YAZ_VERSION
userInformationField Z_UserInformation NULL
otherInfo Z_OtherInformation NULL

Table 5.3. Default settings for PDU Search Request

Field Type Default Value
referenceId Z_ReferenceId NULL
smallSetUpperBound int 0
largeSetLowerBound int 1
mediumSetPresentNumber int 0
replaceIndicator bool_t TRUE
resultSetName char * "default"
num_databaseNames int 0
databaseNames char ** NULL
smallSetElementSetNames Z_ElementSetNames NULL
mediumSetElementSetNames Z_ElementSetNames NULL
preferredRecordSyntax Odr_oid NULL
query Z_Query NULL
additionalSearchInfo Z_OtherInformation NULL
otherInfo Z_OtherInformation NULL

Table 5.4. Default settings for PDU Search Response

Field Type Default Value
referenceId Z_ReferenceId NULL
resultCount int 0
numberOfRecordsReturned int 0
nextResultSetPosition int 0
searchStatus bool_t TRUE
resultSetStatus int NULL
presentStatus int NULL
records Z_Records NULL
additionalSearchInfo Z_OtherInformation NULL
otherInfo Z_OtherInformation NULL

Table 5.5. Default settings for PDU Present Request

Field Type Default Value
referenceId Z_ReferenceId NULL
resultSetId char* "default"
resultSetStartPoint int 1
numberOfRecordsRequested int 10
num_ranges int 0
additionalRanges Z_Range NULL
recordComposition Z_RecordComposition NULL
preferredRecordSyntax Odr_oid NULL
maxSegmentCount int NULL
maxRecordSize int NULL
maxSegmentSize int NULL
otherInfo Z_OtherInformation NULL

Table 5.6. Default settings for PDU Present Response

Field Type Default Value
referenceId Z_ReferenceId NULL
numberOfRecordsReturned int 0
nextResultSetPosition int 0
presentStatus int Z_PresentStatus_success
records Z_Records NULL
otherInfo Z_OtherInformation NULL

Table 5.7. Default settings for Delete Result Set Request

Field Type Default Value
referenceId Z_ReferenceId NULL
deleteFunction int Z_DeleteResultSetRequest_list
num_ids int 0
resultSetList char** NULL
otherInfo Z_OtherInformation NULL

Table 5.8. Default settings for Delete Result Set Response

Field Type Default Value
referenceId Z_ReferenceId NULL
deleteOperationStatus int Z_DeleteStatus_success
num_statuses int 0
deleteListStatuses Z_ListStatus** NULL
numberNotDeleted int NULL
num_bulkStatuses int 0
bulkStatuses Z_ListStatus NUL L
deleteMessage char* NULL
otherInfo Z_OtherInformation NULL

Table 5.9. Default settings for Scan Request

Field Type Default Value
referenceId Z_ReferenceId NULL
num_databaseNames int 0
databaseNames char** NULL
attributeSet Odr_oid NULL
termListAndStartPoint Z_AttributesPlus... NULL
stepSize int NULL
numberOfTermsRequested int 20
preferredPositionInResponse int NULL
otherInfo Z_OtherInformation NULL

Table 5.10. Default settings for Scan Response

Field Type Default Value
referenceId Z_ReferenceId NULL
stepSize int NULL
scanStatus int Z_Scan_success
numberOfEntriesReturned int 0
positionOfTerm int NULL
entries Z_ListEntris NULL
attributeSet Odr_oid NULL
otherInfo Z_OtherInformation NULL

Table 5.11. Default settings for Trigger Resource Control Request

Field Type Default Value
referenceId Z_ReferenceId NULL
requestedAction int Z_TriggerResourceCtrl_resou..
prefResourceReportFormat Odr_oid NULL
resultSetWanted bool_t NULL
otherInfo Z_OtherInformation NULL

Table 5.12. Default settings for Resource Control Request

Field Type Default Value
referenceId Z_ReferenceId NULL
suspendedFlag bool_t NULL
resourceReport Z_External NULL
partialResultsAvailable int NULL
responseRequired bool_t FALSE
triggeredRequestFlag bool_t NULL
otherInfo Z_OtherInformation NULL

Table 5.13. Default settings for Resource Control Response

Field Type Default Value
referenceId Z_ReferenceId NULL
continueFlag bool_t TRUE
resultSetWanted bool_t NULL
otherInfo Z_OtherInformation NULL

Table 5.14. Default settings for Access Control Request

Field Type Default Value
referenceId Z_ReferenceId NULL
which enum Z_AccessRequest_simpleForm;
u union NULL
otherInfo Z_OtherInformation NULL

Table 5.15. Default settings for Access Control Response

Field Type Default Value
referenceId Z_ReferenceId NULL
which enum Z_AccessResponse_simpleForm
u union NULL
diagnostic Z_DiagRec NULL
otherInfo Z_OtherInformation NULL

Table 5.16. Default settings for Segment

Field Type Default Value
referenceId Z_ReferenceId NULL
numberOfRecordsReturned int value=0
num_segmentRecords int 0
segmentRecords Z_NamePlusRecord NULL
otherInfo Z_OtherInformation NULL

Table 5.17. Default settings for Close

Field Type Default Value
referenceId Z_ReferenceId NULL
closeReason int Z_Close_finished
diagnosticInformation char* NULL
resourceReportFormat Odr_oid NULL
resourceFormat Z_External NULL
otherInfo Z_OtherInformation NULL