com.technia.helium.search.config.v2

Interface SearchDefV2

All Superinterfaces:

CustomizableDef, com.technia.tvc.core.util.cache.loader.ResourceSource, SearchDef, com.technia.common.xml.XMLReadable

All Known Implementing Classes:

SearchDefV2Impl

public interface SearchDefV2
extends SearchDef, CustomizableDef

Search Configuration.

Since:

2018.1.0

Method Summary

Modifier and Type	Method and Description
SearchV2	createSearch(com.technia.tvc.core.db.aef.env.Environment env, ComponentIdBuilder idBuilder)
ClientEvents	getClientEvents()
java.util.Set<java.lang.String>	getDataFields()
java.lang.String	getHomePage() Returns default homepage for deeplink search
java.lang.String	getId()
int	getInitialHitsCount()
int	getLimit()
com.technia.tvc.search.searchform.config.SearchFormDef	getSearchFormDef()
java.lang.String	getSearchProvider()
com.technia.tvc.search.api.section.SectionProvider	getSectionProvider()
java.util.List<com.technia.tvc.search.section.ui.SectionUI>	getSectionUIs()
ServerTriggers	getServerEvents()
com.technia.tvc.search.api.Settings	getSettings() Settings for the search configuration.
int	getShowMoreHitsCount()
java.lang.String	getTileHitTemplate()
boolean	isOpenOnLoad() Whether search panel should be opened by load
java.lang.Boolean	searchOnCriteriaUpdate()

Methods inherited from interface com.technia.tvc.core.util.cache.loader.ResourceSource

getResourceLastModified

Methods inherited from interface com.technia.common.xml.XMLReadable

initialize

Methods inherited from interface com.technia.helium.customization.CustomizableDef

createIdBuilder

Method Detail

getId

java.lang.String getId()

Returns:

The id of the search configuration

Since:

2018.1.0

getLimit

int getLimit()

Returns:

The limit for search

Since:

2018.1.0

getTileHitTemplate

java.lang.String getTileHitTemplate()

Returns:

The template defining how to display a hit in the search result

Since:

2018.1.0

getInitialHitsCount

int getInitialHitsCount()

Returns:

Initial number of hits to be shown in search result

Since:

2018.2.0

getShowMoreHitsCount

int getShowMoreHitsCount()

Returns:

Additional number of hits to be shown in search result

Since:

2018.2.0

getDataFields

java.util.Set<java.lang.String> getDataFields()

Returns:

The data field select statements describing what data to include in the search result

Since:

2018.1.0

getSearchFormDef

com.technia.tvc.search.searchform.config.SearchFormDef getSearchFormDef()

Returns:

The SearchFormDef which is used for advanced search

Since:

2018.1.0

searchOnCriteriaUpdate

java.lang.Boolean searchOnCriteriaUpdate()

Returns:

True if searching automatically when the criteria is updated, otherwise false.

Since:

2018.3.0

getSettings

com.technia.tvc.search.api.Settings getSettings()

Settings for the search configuration. Settings may effect both the user interface and how the search provider operates. See each search provider for details on which settings it supports.

Returns:

The settings

Since:

2018.1.0

getServerEvents

ServerTriggers getServerEvents()

Returns:

The registered server-side events

Since:

2018.1.0

getClientEvents

ClientEvents getClientEvents()

Returns:

The registered client-side events

Since:

2018.1.0

getSectionUIs

java.util.List<com.technia.tvc.search.section.ui.SectionUI> getSectionUIs()

Returns:

The Section UIs for rendering result

Since:

2018.2.0

createSearch

SearchV2 createSearch(com.technia.tvc.core.db.aef.env.Environment env,
                      ComponentIdBuilder idBuilder)

Parameters:

env - Environment

idBuilder - ComponentIdBuilder

Returns:

The search instance based on this configuration / definition

Since:

2018.1.0

getSearchProvider

java.lang.String getSearchProvider()

Returns:

The searchprovider

Since:

2018.1.0

getSectionProvider

com.technia.tvc.search.api.section.SectionProvider getSectionProvider()

Returns:

The sectionProvider

Since:

2018.3.0

isOpenOnLoad

boolean isOpenOnLoad()

Whether search panel should be opened by load

Returns:

boolean

Since:

2019.1.0

getHomePage

java.lang.String getHomePage()

Returns default homepage for deeplink search

Returns:

boolean

Since:

2019.5.0