org.opencms.search.galleries
Class CmsGallerySearch

java.lang.Object
  org.opencms.search.galleries.CmsGallerySearch

public class CmsGallerySearch
extends java.lang.Object

Contains the functions for the gallery search.

Since:

8.0.0

Field Summary

protected CmsObject	m_cms The OpenCms object used for the search.
protected java.lang.Exception	m_lastException The latest exception.

Constructor Summary

CmsGallerySearch()

Method Summary

java.lang.String	getIndex() Returns the name of the current search index.
java.lang.Exception	getLastException() Returns the last exception that occurred during the last search operation.
CmsGallerySearchResultList	getResult(CmsGallerySearchParameters params) Returns the gallery search result list.
CmsGallerySearchIndex	getSearchIndex() Returns the current gallery search index.
void	init(CmsObject cms) Initializes the bean with the provided OpenCms context object.
void	setIndex(java.lang.String indexName) Set the name of the index to search.

Methods inherited from class java.lang.Object

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

Field Detail

m_cms

protected transient CmsObject m_cms

The OpenCms object used for the search.

m_lastException

protected java.lang.Exception m_lastException

The latest exception.

Constructor Detail

CmsGallerySearch

public CmsGallerySearch()

Method Detail

getIndex

public java.lang.String getIndex()

Returns the name of the current search index.

Returns:

the name of the current search index

getLastException

public java.lang.Exception getLastException()

Returns the last exception that occurred during the last search operation.

Returns:

the last exception that occurred during the last search operation

getResult

public CmsGallerySearchResultList getResult(CmsGallerySearchParameters params)

Returns the gallery search result list.

Parameters:

params - the gallery search parameters

Returns:

the gallery search result list

getSearchIndex

public CmsGallerySearchIndex getSearchIndex()

Returns the current gallery search index.

Returns:

the current gallery search index

init

public void init(CmsObject cms)

Initializes the bean with the provided OpenCms context object.

Parameters:

cms - the OpenCms context to use for the search

setIndex

public void setIndex(java.lang.String indexName)

Set the name of the index to search.

A former search result will be deleted.

Parameters:

indexName - the name of the index