com.rometools.modules.opensearch.impl

Class OpenSearchModuleImpl

java.lang.Object

com.rometools.rome.feed.module.ModuleImpl

com.rometools.modules.opensearch.impl.OpenSearchModuleImpl

All Implemented Interfaces:

OpenSearchModule, OpenSearchResponse, CopyFrom, Module, Serializable, Cloneable

public class OpenSearchModuleImpl
extends ModuleImpl
implements OpenSearchModule, Serializable

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.rometools.modules.opensearch.OpenSearchModule

URI

Constructor Summary

Constructors

Constructor and Description
OpenSearchModuleImpl()

Method Summary

Modifier and Type	Method and Description
void	addQuery(OSQuery query) Adds a query to the module.
void	copyFrom(CopyFrom obj)
Class<OpenSearchModule>	getInterface()
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.

Methods inherited from class com.rometools.rome.feed.module.ModuleImpl

clone, equals, getUri, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.rometools.rome.feed.module.Module

clone, getUri

Constructor Detail

OpenSearchModuleImpl

public OpenSearchModuleImpl()

Method Detail

getItemsPerPage

public int getItemsPerPage()

Description copied from interface: OpenSearchResponse

# itemsPerPage – the maximum number of items that can appear in one page of results. * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May appear zero or one time.

Specified by:

getItemsPerPage in interface OpenSearchResponse

Returns:

Returns the itemsPerPage.

setItemsPerPage

public void setItemsPerPage(int itemsPerPage)

Description copied from interface: OpenSearchResponse

# itemsPerPage – the maximum number of items that can appear in one page of results. * Restrictions: An integer greater than or equal to 1. * Default: The number of items that were returned in this set of results. * Requirements: May appear zero or one time.

Specified by:

setItemsPerPage in interface OpenSearchResponse

Parameters:

itemsPerPage - The itemsPerPage to set.

getLink

public Link getLink()

Description copied from interface: OpenSearchResponse

# 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. * Restrictions: The rel attribute must equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time.

Specified by:

getLink in interface OpenSearchResponse

Returns:

Returns the link.

setLink

public void setLink(Link link)

Description copied from interface: OpenSearchResponse

# 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. * Restrictions: The rel attribute must equal search. * Note: New in version 1.1. * Requirements: May appear zero or one time.

Specified by:

setLink in interface OpenSearchResponse

Parameters:

link - The link to set.

getQueries

public List<OSQuery> getQueries()

Description copied from interface: 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.

• Note: New in version 1.1.
• Requirements: May appear zero or more times. Note that the “Q” is capitalized.

Specified by:

getQueries in interface OpenSearchResponse

Returns:

Returns the queries.

setQueries

public void setQueries(List<OSQuery> queries)

Description copied from interface: 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.

• Note: New in version 1.1.
• Requirements: May appear zero or more times. Note that the “Q” is capitalized.

Specified by:

setQueries in interface OpenSearchResponse

Parameters:

queries - The queries to set.

addQuery

public void addQuery(OSQuery query)

Description copied from interface: OpenSearchResponse

Adds a query to the module.

Specified by:

addQuery in interface OpenSearchResponse

Parameters:

query - OSQuery object to add.

getStartIndex

public int getStartIndex()

Description copied from interface: OpenSearchResponse

# startIndex – the index of the first item returned in the result. * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time.

Specified by:

getStartIndex in interface OpenSearchResponse

Returns:

Returns the startIndex.

setStartIndex

public void setStartIndex(int startIndex)

Description copied from interface: OpenSearchResponse

# startIndex – the index of the first item returned in the result. * Restrictions: An integer greater than or equal to 1. * Note: The first result is 1. * Default: 1 * Requirements: May appear zero or one time.

Specified by:

setStartIndex in interface OpenSearchResponse

Parameters:

startIndex - The startIndex to set.

getTotalResults

public int getTotalResults()

Description copied from interface: OpenSearchResponse

# totalResults – the maximum number of results available for these search terms * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May appear zero or one time.

Specified by:

getTotalResults in interface OpenSearchResponse

Returns:

Returns the totalResults.

setTotalResults

public void setTotalResults(int totalResults)

Description copied from interface: OpenSearchResponse

# totalResults – the maximum number of results available for these search terms * Restrictions: An integer greater than or equal to 0. * Default: The number of items that were returned in this set of results. * Requirements: May appear zero or one time.

Specified by:

setTotalResults in interface OpenSearchResponse

Parameters:

totalResults - The totalResults to set.

copyFrom

public void copyFrom(CopyFrom obj)

Specified by:

copyFrom in interface CopyFrom

getInterface

public Class<OpenSearchModule> getInterface()

Specified by:

getInterface in interface CopyFrom