de.geeksfactory.opacclient.objects

Class SearchRequestResult

java.lang.Object

de.geeksfactory.opacclient.objects.SearchRequestResult

public class SearchRequestResult
extends java.lang.Object

Object representing a search result

Since:

2.0.6

Constructor Summary

Constructors

Constructor and Description
SearchRequestResult(java.util.List<SearchResult> results, int total_result_count, int page_index)
SearchRequestResult(java.util.List<SearchResult> results, int total_result_count, int page_count, int page_index)

Method Summary

Modifier and Type	Method and Description
java.util.List<Filter>	getFilters() Some libraries support a "refined search": On the search results page you have a list of options to refine your search, for example "Media type" with the options "book", "cd" or "movie" or "Language" with "German" or "English".
int	getPage_count()
int	getPage_index()
java.util.List<SearchResult>	getResults()
int	getTotal_result_count()
void	setFilters(java.util.List<Filter> filters) Some libraries support a "refined search": On the search results page you have a list of options to refine your search, for example "Media type" with the options "book", "cd" or "movie" or "Language" with "German" or "English".
void	setPage_count(int page_count)
void	setPage_number(int page_index)
void	setResults(java.util.List<SearchResult> results)
void	setTotal_result_count(int total_result_count)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchRequestResult

public SearchRequestResult(java.util.List<SearchResult> results,
                           int total_result_count,
                           int page_count,
                           int page_index)

Parameters:

results - The results found for this search.

total_result_count - The total number of results for the search request.

page_count - The total number of result pages for the search request.

page_index - The index of the result page requested.

SearchRequestResult

public SearchRequestResult(java.util.List<SearchResult> results,
                           int total_result_count,
                           int page_index)

Parameters:

results - The results found for this search.

total_result_count - The total number of results for the search request.

page_index - The index of the result page requested.

Method Detail

getTotal_result_count

public int getTotal_result_count()

Returns:

The total number of results for the search request.

setTotal_result_count

public void setTotal_result_count(int total_result_count)

Parameters:

total_result_count - The total number of results for the search request.

getPage_count

public int getPage_count()

Returns:

The total number of result pages for the search request.

setPage_count

public void setPage_count(int page_count)

Parameters:

page_count - The total number of result pages for the search request.

getPage_index

public int getPage_index()

Returns:

The index of the result page requested.

setPage_number

public void setPage_number(int page_index)

Parameters:

page_index - The index of the result page requested.

getResults

public java.util.List<SearchResult> getResults()

setResults

public void setResults(java.util.List<SearchResult> results)

Parameters:

results - The results found for this search.

getFilters

public java.util.List<Filter> getFilters()

Some libraries support a "refined search": On the search results page you have a list of options to refine your search, for example "Media type" with the options "book", "cd" or "movie" or "Language" with "German" or "English". If a library does support this, this returns the filters available for the search results last displayed by OpacApi.search(List). If a library does not, this is null .

Returns:

List of filters available

Since:

2.0.6

See Also:

Filter

setFilters

public void setFilters(java.util.List<Filter> filters)

Some libraries support a "refined search": On the search results page you have a list of options to refine your search, for example "Media type" with the options "book", "cd" or "movie" or "Language" with "German" or "English". If your library does support this, this must return the filters available for the search results last displayed by OpacApi.search(List). If your library does not, just set null.

Parameters:

filters - List of filters available

Since:

2.0.6

See Also:

Filter