public interface OpenSearchResponse
Modifier and Type | Method and Description |
---|---|
void |
addQuery(OSQuery query)
Adds a query to the module.
|
int |
getItemsPerPage()
# itemsPerPage – the maximum number of items that can appear in one page of results.
|
Link |
getLink()
# link – a reference back to the OpenSearch Description file
* Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and
type attributes.
|
List<OSQuery> |
getQueries()
Query – in an OpenSearch Response, can be used both to echo back the original
query and to suggest new searches. |
int |
getStartIndex()
# startIndex – the index of the first item returned in the result.
|
int |
getTotalResults()
# totalResults – the maximum number of results available for these search terms
* Restrictions: An integer greater than or equal to 0.
|
void |
setItemsPerPage(int itemsPerPage)
# itemsPerPage – the maximum number of items that can appear in one page of results.
|
void |
setLink(Link link)
# link – a reference back to the OpenSearch Description file
* Attributes: This is a clone of the link element in Atom, including href, hreflang, rel, and
type attributes.
|
void |
setQueries(List<OSQuery> query)
Query – in an OpenSearch Response, can be used both to echo back the original
query and to suggest new searches. |
void |
setStartIndex(int startIndex)
# startIndex – the index of the first item returned in the result.
|
void |
setTotalResults(int totalResults)
# totalResults – the maximum number of results available for these search terms
* Restrictions: An integer greater than or equal to 0.
|
void setTotalResults(int totalResults)
totalResults
- A positive integer value.int getTotalResults()
void setStartIndex(int startIndex)
startIndex
- int value >= 1.int getStartIndex()
void setItemsPerPage(int itemsPerPage)
itemsPerPage
- int value >= 1.int getItemsPerPage()
void setLink(Link link)
link
- link to the open search spec.Link getLink()
void setQueries(List<OSQuery> query)
Query
– in an OpenSearch Response, can be used both to echo back the original
query and to suggest new searches. Please see the OpenSearch Query
specification for more information.
query
- List of OSQuery objects.List<OSQuery> getQueries()
Query
– in an OpenSearch Response, can be used both to echo back the original
query and to suggest new searches. Please see the OpenSearch Query
specification for more information.
void addQuery(OSQuery query)
query
- OSQuery object to add.Copyright © 2022. All rights reserved.