《searchRetrieve Part . APD Binding for OpenSearch Version ..doc》由会员分享，可在线阅读，更多相关《searchRetrieve Part . APD Binding for OpenSearch Version ..doc（22页珍藏版）》请在三一文库上搜索。
1、searchRetrieve: Part 4. APD Binding for OpenSearch Version 1.0OASIS Standard30 January 2013Specification URIsThis version:http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os-part4-opensearch.doc (Authoritative)http:/docs.oasis-open.org/search-ws/searchR
2、etrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os-part4-opensearch.html http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os-part4-opensearch.pdf Previous version:N/ALatest version:http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetri
3、eve-v1.0-part4-opensearch.doc (Authoritative)http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetrieve-v1.0-part4-opensearch.htmlhttp:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/searchRetrieve-v1.0-part4-opensearch.pdfTechnical Committee:OASIS Search Web Services TCChairs:Ray Den
4、enberg (rdenloc.gov), Library of CongressMatthew Dovey (m.doveyjisc.ac.uk), JISC Executive, University of BristolEditors:Ray Denenberg (rdenloc.gov), Library of CongressLarry Dixson (ldixloc.gov), Library of CongressRalph Levan (levanoclc.org), OCLCJanifer Gatenby (Janifer.Gatenbyoclc.org), OCLCTony
5、 Hammond (), Nature Publishing GroupMatthew Dovey (m.doveyjisc.ac.uk), JISC Executive, University of BristolAdditional artifacts:This prose specification is one component of a Work Product which also includes: XML schemas: http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/schemas/ searchRet
6、rieve: Part 0. Overview Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part0-overview/searchRetrieve-v1.0-os-part0-overview.html searchRetrieve: Part 1. Abstract Protocol Definition Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part1-apd/searchRetriev
7、e-v1.0-os-part1-apd.html searchRetrieve: Part 2. searchRetrieve Operation: APD Binding for SRU 1.2 Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part2-sru1.2/searchRetrieve-v1.0-os-part2-sru1.2.html searchRetrieve: Part 3. searchRetrieve Operation: APD Binding for SRU 2.0 Ve
8、rsion 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part3-sru2.0/searchRetrieve-v1.0-os-part3-sru2.0.html searchRetrieve: Part 4. APD Binding for OpenSearch Version 1.0. (this document)http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os
9、-part4-opensearch.html searchRetrieve: Part 5. CQL: The Contextual Query Language Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part5-cql/searchRetrieve-v1.0-os-part5-cql.html searchRetrieve: Part 6. SRU Scan Operation Version 1.0.http:/docs.oasis-open.org/search-ws/searchRe
10、trieve/v1.0/os/part6-scan/searchRetrieve-v1.0-os-part6-scan.html searchRetrieve: Part 7. SRU Explain Operation Version 1.0.http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part7-explain/searchRetrieve-v1.0-os-part7-explain.html Related work:This specification is related to: OpenSearch 1.1
11、Draft 5 specification. http:/www.opensearch.org/Specifications/OpenSearch/1.1/Draft_5Abstract:This document, “APD Binding for OpenSearch” is a binding of the OASIS SWS Abstract Protocol Definition to the OpenSearch version 1.1 Draft 5 Specification. This is one of a set of documents for the OASIS Se
12、arch Web Services (SWS) initiative.Status:This document was last revised or approved by the membership of OASIS on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.Technical Committee members sho
13、uld send comments on this specification to the Technical Committees email list. Others should send comments to the Technical Committee by using the “Send A Comment” button on the Technical Committees web page at http:/www.oasis-open.org/committees/search-ws/.For information on whether any patents ha
14、ve been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http:/www.oasis-open.org/committees/search-ws/ipr.php).Citation format:When referencing
15、this specification the following citation format should be used:SearchRetrievePt4searchRetrieve: Part 4. APD Binding for OpenSearch Version 1.0. 30 January 2013. OASIS Standard. http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/os/part4-opensearch/searchRetrieve-v1.0-os-part4-opensearch.html.
16、NoticesCopyright OASIS Open 2013. All Rights Reserved.All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the OASIS IPR Policy). The full Policy may be found at the OASIS website.This document and translations of it may be
17、copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are includ
18、ed on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which c
19、ase the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.This document and the inf
20、ormation contained herein is provided on an AS IS basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTIC
21、ULAR PURPOSE.OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to gran
22、t patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infri
23、nged by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any
24、obligation to do so.OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not
25、be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available
26、 for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC
27、Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.The name OASIS is a trademark of OASIS, the owner and developer of this specification, and should be
28、used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http:/www.oasis-open.org/policies-guidelines/trademark for above guidance.Ta
29、ble of Contents1Introduction51.1 Terminology51.2 References51.3 Namespace52Model62.1 Relationship to Abstract Protocol Definition62.2 Processing Model62.3 Result Set Model72.4 Data Model72.5 Diagnostic Model72.6 Description and Discovery Model73OpenSearch Request93.1 Actual Request Parameters for th
30、is Binding93.2 Abstract Vs. Actual Parameters94OpenSearch Response104.1 Response Elements104.1.1 Actual Response Elements104.1.2 Abstract Vs. Actual Elements104.2 OpenSearch Response Examples115Open Search Description Document145.1 Description Elements145.1.1 URL Element165.1.2 Query Element175.2 Ex
31、ample Description Documents185.3 Extensibility195.4 Autodiscovery196Conformance216.1 Client Conformance216.2 Server Conformance21Appendix A.Acknowledgements22searchRetrieve-v1.0-os-part4-opensearch30 January 2013Standards Track Work ProductCopyright OASIS Open 2013. All Rights Reserved.Page 22 of 22
32、1 IntroductionThis is one of a set of documents for the OASIS Search Web Services (SWS) initiative. This document, “APD Binding for OpenSearch” is a binding of the OASIS SWS Abstract Protocol Definition. This specification is intended to be fully compatible with http:/www.opensearch.org/Specificatio
33、ns/OpenSearch/1.1/Draft_5The set of documents includes the Abstract Protocol Definition (APD) for searchRetrieve operation, which presents the model for the SearchRetrieve operation and serves as a guideline for the development of application protocol bindings describing the capabilities and general
34、 characteristic of a server or search engine, and how it is to be accessed. The collection of documents also includes three bindings (3, 4, and 5 in the list below). This document is one of the three. The eight documents in this collection of specifications are:1. Overview2. APD 3. SRU1.2 4. SRU2.05
35、. OpenSearch (this document)6. CQL 7. Scan 8. Explain1.1 TerminologyThe key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC2119.1.2 ReferencesAll references for the set
36、 of documents in this collection are supplied in the Overview document:searchRetrieve: Part 0. Overview Version 1.0http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part0-overview/searchRetrieve-v1.0-csd01-part0-overview.doc 1.3 NamespaceAll XML namespaces for the set of documents in thi
37、s collection are supplied in the Overview document: searchRetrieve: Part 0. Overview Version 1.0http:/docs.oasis-open.org/search-ws/searchRetrieve/v1.0/csd01/part0-overview/searchRetrieve-v1.0-csd01-part0-overview.doc2 ModelThis document describes the OpenSearch model, request parameters, response e
38、lements, and description document.Search clients can use OpenSearch description documents to learn about the public interface of a search engine. These description documents contain parameterized URL templates that indicate how the search client should make search requests. 2.1 Relationship to Abstr
39、act Protocol DefinitionThe APD defines abstract request parameters and abstract response elements. A binding lists those abstract parameters and elements applicable to that binding and indicates the corresponding actual name of the parameter or element to be transmitted in a request or response.Exam
40、ple.The APD defines the abstract parameter: startPosition as “The position within the result set of the first item to be returned.“And OpenSearch refers to that abstract parameter and notes that its name, as used in the OpenSearch specification is startIndex. Thus the request parameter startRecord i
41、n OpenSearch represents the abstract parameter startPosition in the APD. Different bindings may use different names to represent this same abstract parameter, and its semantics may differ across those bindings as the binding models differ. It is the responsibility of the binding to explain these dif
42、ferences in terms of their respective models.2.2 Processing ModelA server provides a description document that a client reads to determine how to formulate a search/retrieve request and interpret the response. The client may send a request, including search terms, to the server, who replies with a r
43、esponse that includes results based on the search terms.The server returns results either as a stream (“stream mode”) or a page (“page mode”). A stream is an arbitrary range of results, for example, results 10 through 100. In page mode, the server groups the results into pages, and returns one page.
44、 The server will always return results as a stream or always as a page, and indicates one or the other in its description file. If the server returns a page, the request may include the count parameter, suggesting how many results there should be per page. The request may also include the startPage
45、parameter indicating which page is desired. (See note 1.) The server may ignore the count parameter and determine the number of results per page itself. (See note 2.) If the server returns a stream, the request may include the parameter startIndex to indicate the desired position within the result s
46、et of the first result within the stream. For example if the value of the startIndex parameter is 61, and if the server returns 30 results, the stream will consist of results 61 through 90. The request may also include the count parameter (for example, a value of 30, if the client wants results 61 t
47、hrough 90) but the server may ignore it. (See note 3.)The response includes the element , the number of results found by the search. This element will be omitted only if the last of the available results is included in the response. So the client can scroll through the results by issuing repeated re
48、quests until there is a response which omits the element, the omission signaling that there are no further results. Each request uses the same value for the parameter searchTerms, and : In stream mode: the value of the parameter startIndex is the previous value plus the number of results included in the previous response. In page mode: the value of the parameter startPage is the previous value plus