public class OpenSearchModuleImpl extends ModuleImpl implements OpenSearchModule, Serializable
URI
Constructor and Description |
---|
OpenSearchModuleImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addQuery(OSQuery query)
Adds a query to the module.
|
void |
copyFrom(CopyFrom obj)
Copies all the properties of the given bean into this one.
|
Class<OpenSearchModule> |
getInterface()
Returns the interface the copyFrom works on.
|
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> queries)
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.
|
clone, equals, getUri, hashCode, toString
public int getItemsPerPage()
OpenSearchResponse
getItemsPerPage
in interface OpenSearchResponse
public void setItemsPerPage(int itemsPerPage)
OpenSearchResponse
setItemsPerPage
in interface OpenSearchResponse
itemsPerPage
- The itemsPerPage to set.public Link getLink()
OpenSearchResponse
getLink
in interface OpenSearchResponse
public void setLink(Link link)
OpenSearchResponse
setLink
in interface OpenSearchResponse
link
- The link to set.public List<OSQuery> getQueries()
OpenSearchResponse
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.
getQueries
in interface OpenSearchResponse
public void setQueries(List<OSQuery> queries)
OpenSearchResponse
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.
setQueries
in interface OpenSearchResponse
queries
- The queries to set.public void addQuery(OSQuery query)
OpenSearchResponse
addQuery
in interface OpenSearchResponse
query
- OSQuery object to add.public int getStartIndex()
OpenSearchResponse
getStartIndex
in interface OpenSearchResponse
public void setStartIndex(int startIndex)
OpenSearchResponse
setStartIndex
in interface OpenSearchResponse
startIndex
- The startIndex to set.public int getTotalResults()
OpenSearchResponse
getTotalResults
in interface OpenSearchResponse
public void setTotalResults(int totalResults)
OpenSearchResponse
setTotalResults
in interface OpenSearchResponse
totalResults
- The totalResults to set.public void copyFrom(CopyFrom obj)
CopyFrom
Any existing properties in this bean are lost.
This method is useful for moving from one implementation of a bean interface to another. For example from the default SyndFeed bean implementation to a Hibernate ready implementation.
public Class<OpenSearchModule> getInterface()
CopyFrom
This is useful when dealing with properties that may have multiple implementations. For example, Module.
getInterface
in interface CopyFrom
Copyright © 2018. All rights reserved.