java.lang.Object
- org.opencms.search.galleries.CmsGallerySearchParameters

public class CmsGallerySearchParameters
extends java.lang.Object

Parameters used for the gallery search index.

Since:: 8.0.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CmsGallerySearchParameters.CmsGallerySortParam
Sort parameter constants.

Constructor Summary

Constructors
Constructor Description

CmsGallerySearchParameters()
Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.util.List<java.lang.String>`	`getCategories()`	Returns the categories that have been included in the search.
`org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange`	`getDateCreatedRange()`	Returns the time range for the date of creation that has been used for the search result.
`org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange`	`getDateLastModifiedRange()`	Returns the time range for the dadelete examplete of last modification that has been used for the search result.
`java.util.Set<CmsUUID>`	`getExcludedFunctions()`	Gets the set of structure IDs of functions to exclude from the search result.
`java.util.List<java.lang.String>`	`getFolders()`	Returns the list of folders to search in.
`java.util.List<java.lang.String>`	`getGalleries()`	Returns the galleries that have been included in the search.
`java.util.Set<CmsUUID>`	`getIncludedFunctions()`	Gets the set of ids of functions to include.
`java.lang.String`	`getLocale()`	Returns the locale that has been used for the search.
`int`	`getMatchesPerPage()`	Returns the maximum number of matches per result page.
`CmsSolrQuery`	`getQuery(CmsObject cms)`	Returns a CmsSolrQuery representation of this class.
`java.lang.String`	`getReferencePath()`	Gets the reference path.
`java.util.List<java.lang.String>`	`getResourceTypes()`	Returns the names of the resource types that have been included in the search result.
`int`	`getResultPage()`	Returns the index of the requested result page.
`CmsGallerySearchScope`	`getScope()`	The gallery search scope.
`java.lang.String`	`getSearchWords()`	Returns the words (terms) that have been used for the full text search.
`CmsGallerySearchParameters.CmsGallerySortParam`	`getSortOrder()`	Returns the sort order that has been used in the search.
`java.lang.String`	`getTemplateCompatibility()`	Gets the template compatibility.
`boolean`	`isForceEmptyResult()`	If this returns true, an empty search result should be returned, regardless of other settings.
`boolean`	`isIgnoreSearchExclude()`	Returns the search exclude property ignore flag.
`boolean`	`isIncludeExpired()`	Returns a flag, indicating if release and expiration date should be ignored.
`void`	`setCategories(java.util.List<java.lang.String> categories)`	Sets the categories for the search.
`void`	`setDateCreatedTimeRange(long startTime, long endTime)`	Sets the time range for the date of resource creation to consider in the search.
`void`	`setDateLastModifiedTimeRange(long startTime, long endTime)`	Sets the time range for the date of resource last modification to consider in the search.
`void`	`setExcludedFunctions(java.util.Set<CmsUUID> excludedFunctions)`	Sets the structure IDs of functions to exclude from the search results.
`void`	`setFolders(java.util.List<java.lang.String> folders)`	Sets the folders to search in.
`void`	`setForceEmptyResult(boolean forceEmptyResult)`	Enables/disables the 'force empty result' flag.
`void`	`setFunctionAvailability(CmsFunctionAvailability dynamicFunctionAvailability)`	Sets the dynamic function availability.
`void`	`setGalleries(java.util.List<java.lang.String> galleries)`	Sets the galleries for the search.
`void`	`setIgnoreSearchExclude(boolean excludeForPageEditor)`	Sets the search exclude property ignore flag.
`void`	`setIncludedFunctions(java.util.Set<CmsUUID> includedFunctions)`	Sets the ids of functions to include.
`void`	`setIncludeExpired(boolean includeExpired)`	Set the flag, determining if expired and unreleased resources should be shown.
`void`	`setMatchesPerPage(int matchesPerPage)`	Sets the maximum number of matches per result page.
`void`	`setReferencePath(java.lang.String referencePath)`	Sets the gallery reference path.
`void`	`setResourceTypes(java.util.List<java.lang.String> resourceTypes)`	Sets the names of the resource types to include in the search result.
`void`	`setResultPage(int resultPage)`	Sets the index of the result page that should be returned.
`void`	`setScope(CmsGallerySearchScope scope)`	Sets the search scope.
`void`	`setSearchLocale(java.lang.String locale)`	Sets the locale for the search.
`void`	`setSearchWords(java.lang.String words)`	Sets the words (terms) for the full text search.
`void`	`setSortOrder(CmsGallerySearchParameters.CmsGallerySortParam sortOrder)`	Sets the sort order for the search.
`void`	`setTemplateCompatibility(java.lang.String compatibility)`	Sets the template compatibility string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CmsGallerySearchParameters
```
public CmsGallerySearchParameters()
```
    Default constructor.
- Method Detail
  - getCategories
```
public java.util.List<java.lang.String> getCategories()
```
    Returns the categories that have been included in the search.
    If no categories have been set, then null is returned.
    
    Returns:
    
    the categories that have been included in the search
  - getDateCreatedRange
```
public org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange getDateCreatedRange()
```
    Returns the time range for the date of creation that has been used for the search result.
    In case this time range has not been set, this will return an object where the start date is equal to Long.MIN_VALUE and the end date is equal to Long.MAX_VALUE.
    
    Returns:
    
    the time range for the date of creation that has been used for the search result
  - getDateLastModifiedRange
```
public org.opencms.search.galleries.CmsGallerySearchParameters.CmsGallerySearchTimeRange getDateLastModifiedRange()
```
    Returns the time range for the dadelete examplete of last modification that has been used for the search result.
    In case this time range has not been set, this will return an object where the start date is equal to Long.MIN_VALUE and the end date is equal to Long.MAX_VALUE.
    
    Returns:
    
    the time range for the date of last modification that has been used for the search result
  - getExcludedFunctions
```
public java.util.Set<CmsUUID> getExcludedFunctions()
```
    Gets the set of structure IDs of functions to exclude from the search result.
    
    Returns:
    
    the set of structure IDs to exclude
  - getFolders
```
public java.util.List<java.lang.String> getFolders()
```
    Returns the list of folders to search in.
    
    Returns:
    
    a list of paths of VFS folders
  - getGalleries
```
public java.util.List<java.lang.String> getGalleries()
```
    Returns the galleries that have been included in the search.
    If no galleries have been set, then null is returned.
    
    Returns:
    
    the galleries that have been included in the search
  - getIncludedFunctions
```
public java.util.Set<CmsUUID> getIncludedFunctions()
```
    Gets the set of ids of functions to include.
    Note: If the id of a function is returned in the ID set returned by thsi method, the function may still be excluded from search results based on other parameters.
    
    Returns:
    
    the included functions
  - getLocale
```
public java.lang.String getLocale()
```
    Returns the locale that has been used for the search.
    If no locale has been set, then null is returned.
    
    Returns:
    
    the locale that has been used for the search
  - getMatchesPerPage
```
public int getMatchesPerPage()
```
    Returns the maximum number of matches per result page.
    
    Returns:
    
    the the maximum number of matches per result page
    
    See Also:
    
    getMatchesPerPage(), setResultPage(int)
  - getQuery
```
public CmsSolrQuery getQuery(CmsObject cms)
```
    Returns a CmsSolrQuery representation of this class.
    
    Parameters:
    
    cms - the openCms object.
    
    Returns:
    
    CmsSolrQuery representation of this class.
  - getReferencePath
```
public java.lang.String getReferencePath()
```
    Gets the reference path.
    
    Returns:
    
    the gallery reference path
  - getResourceTypes
```
public java.util.List<java.lang.String> getResourceTypes()
```
    Returns the names of the resource types that have been included in the search result.
    If no resource types have been set, then null is returned.
    
    Returns:
    
    the names of the resource types that have been included in the search result
  - getResultPage
```
public int getResultPage()
```
    Returns the index of the requested result page.
    
    Returns:
    
    the index of the requested result page
    
    See Also:
    
    setResultPage(int), getMatchesPerPage(), setMatchesPerPage(int)
  - getScope
```
public CmsGallerySearchScope getScope()
```
    The gallery search scope.
    
    Returns:
    
    the gallery search scope
  - getSearchWords
```
public java.lang.String getSearchWords()
```
    Returns the words (terms) that have been used for the full text search.
    If no search words have been set, then null is returned.
    
    Returns:
    
    the words (terms) that have been used for the full text search
  - getSortOrder
```
public CmsGallerySearchParameters.CmsGallerySortParam getSortOrder()
```
    Returns the sort order that has been used in the search.
    If the sort parameter has not been set the default sort order defined by CmsGallerySearchParameters.CmsGallerySortParam.DEFAULT is used.
    
    Returns:
    
    the sort order that has been used in the search
  - getTemplateCompatibility
```
public java.lang.String getTemplateCompatibility()
```
    Gets the template compatibility.
    If set, matches those resources whose template.compatibility property is either empty or contains the value (possibly together with other values, separated by whitespace).
    
    Returns:
    
    the template compatibility
  - isForceEmptyResult
```
public boolean isForceEmptyResult()
```
    If this returns true, an empty search result should be returned, regardless of other settings.
    
    Returns:
    
    true if an empty search result should be forced
  - isIgnoreSearchExclude
```
public boolean isIgnoreSearchExclude()
```
    Returns the search exclude property ignore flag.
    
    Returns:
    
    the search exclude property ignore flag
  - isIncludeExpired
```
public boolean isIncludeExpired()
```
    Returns a flag, indicating if release and expiration date should be ignored.
    
    Returns:
    
    a flag, indicating if release and expiration date should be ignored
  - setCategories
```
public void setCategories(java.util.List<java.lang.String> categories)
```
    Sets the categories for the search.
    Results are found only if they are contained in at least one of the given categories.
    
    Parameters:
    
    categories - the categories to set
  - setDateCreatedTimeRange
```
public void setDateCreatedTimeRange(long startTime,
                                    long endTime)
```
    Sets the time range for the date of resource creation to consider in the search.
    
    Parameters:
    
    startTime - the start time of the time range
    
    endTime - the end time of the time range
  - setDateLastModifiedTimeRange
```
public void setDateLastModifiedTimeRange(long startTime,
                                         long endTime)
```
    Sets the time range for the date of resource last modification to consider in the search.
    
    Parameters:
    
    startTime - the start time of the time range
    
    endTime - the end time of the time range
  - setExcludedFunctions
```
public void setExcludedFunctions(java.util.Set<CmsUUID> excludedFunctions)
```
    Sets the structure IDs of functions to exclude from the search results.
    
    Parameters:
    
    excludedFunctions - the structure IDs of functions to exclude
  - setFolders
```
public void setFolders(java.util.List<java.lang.String> folders)
```
    Sets the folders to search in.
    
    Parameters:
    
    folders - the list of VFS folders
  - setForceEmptyResult
```
public void setForceEmptyResult(boolean forceEmptyResult)
```
    Enables/disables the 'force empty result' flag. If this is set to true, an empty search result should be returned regardless of the other parameters.
    
    Parameters:
    
    forceEmptyResult - if true, force an empty search result
  - setFunctionAvailability
```
public void setFunctionAvailability(CmsFunctionAvailability dynamicFunctionAvailability)
```
    Sets the dynamic function availability.
    
    Parameters:
    
    dynamicFunctionAvailability - the dynamic function availability
  - setGalleries
```
public void setGalleries(java.util.List<java.lang.String> galleries)
```
    Sets the galleries for the search.
    Results are found only if they are contained in one of the given galleries. If no gallery is set, results from all galleries will be returned in the search result.
    
    Parameters:
    
    galleries - the galleries to set
  - setIgnoreSearchExclude
```
public void setIgnoreSearchExclude(boolean excludeForPageEditor)
```
    Sets the search exclude property ignore flag.
    
    Parameters:
    
    excludeForPageEditor - the search exclude property ignore flag
  - setIncludedFunctions
```
public void setIncludedFunctions(java.util.Set<CmsUUID> includedFunctions)
```
    Sets the ids of functions to include.
    
    Parameters:
    
    includedFunctions - the ids of functions to include
  - setIncludeExpired
```
public void setIncludeExpired(boolean includeExpired)
```
    Set the flag, determining if expired and unreleased resources should be shown.
    
    Parameters:
    
    includeExpired - iff true expired and unreleased resources are shown.
  - setMatchesPerPage
```
public void setMatchesPerPage(int matchesPerPage)
```
    Sets the maximum number of matches per result page.
    Use this together with setResultPage(int) in order to split the result in more than one page.
    
    Parameters:
    
    matchesPerPage - the the maximum number of matches per result page to set
    
    See Also:
    
    getMatchesPerPage(), setResultPage(int)
  - setReferencePath
```
public void setReferencePath(java.lang.String referencePath)
```
    Sets the gallery reference path.
    
    Parameters:
    
    referencePath - the gallery reference path
  - setResourceTypes
```
public void setResourceTypes(java.util.List<java.lang.String> resourceTypes)
```
    Sets the names of the resource types to include in the search result.
    Results are found only if they resources match one of the given resource type names. If no resource type name is set, all resource types will be returned in the search result.
    
    Parameters:
    
    resourceTypes - the names of the resource types to include in the search result
  - setResultPage
```
public void setResultPage(int resultPage)
```
    Sets the index of the result page that should be returned.
    Use this together with setMatchesPerPage(int) in order to split the result in more than one page.
    
    Parameters:
    
    resultPage - the index of the result page to return
    
    See Also:
    
    getResultPage(), getMatchesPerPage(), setMatchesPerPage(int)
  - setScope
```
public void setScope(CmsGallerySearchScope scope)
```
    Sets the search scope.
    
    Parameters:
    
    scope - the search scope
  - setSearchLocale
```
public void setSearchLocale(java.lang.String locale)
```
    Sets the locale for the search.
    Results are found only if they match the given locale. If no locale is set, results for all locales will be returned in the search result.
    
    Parameters:
    
    locale - the locale to set
  - setSearchWords
```
public void setSearchWords(java.lang.String words)
```
    Sets the words (terms) for the full text search.
    Results are found only if they text extraction for the resource contains all given search words. If no search word is set, all resources will be returned in the search result.
    Please note that this should be a list of words separated by white spaces. Simple Lucene modifiers such as (+), (-) and (*) are allowed, but anything more complex then this will be removed.
    
    Parameters:
    
    words - the words (terms) for the full text search to set
  - setSortOrder
```
public void setSortOrder(CmsGallerySearchParameters.CmsGallerySortParam sortOrder)
```
    Sets the sort order for the search.
    
    Parameters:
    
    sortOrder - the sort order to set
  - setTemplateCompatibility
```
public void setTemplateCompatibility(java.lang.String compatibility)
```
    Sets the template compatibility string.
    
    Parameters:
    
    compatibility - the template compatibility string

Class CmsGallerySearchParameters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CmsGallerySearchParameters

Method Detail

getCategories

getDateCreatedRange

getDateLastModifiedRange

getExcludedFunctions

getFolders

getGalleries

getIncludedFunctions

getLocale

getMatchesPerPage

getQuery

getReferencePath

getResourceTypes

getResultPage

getScope

getSearchWords

getSortOrder

getTemplateCompatibility

isForceEmptyResult

isIgnoreSearchExclude

isIncludeExpired

setCategories

setDateCreatedTimeRange

setDateLastModifiedTimeRange

setExcludedFunctions

setFolders

setForceEmptyResult

setFunctionAvailability

setGalleries

setIgnoreSearchExclude

setIncludedFunctions

setIncludeExpired

setMatchesPerPage

setReferencePath

setResourceTypes

setResultPage

setScope

setSearchLocale

setSearchWords

setSortOrder

setTemplateCompatibility