Uses of Class
com.kingsrook.qqq.backend.core.actions.help.HelpSearchResult

Packages that use HelpSearchResult

Package	Description
com.kingsrook.qqq.backend.core.actions.help
com.kingsrook.qqq.middleware.javalin.specs.v1.responses
com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Uses of HelpSearchResult in com.kingsrook.qqq.backend.core.actions.help

Methods in com.kingsrook.qqq.backend.core.actions.help that return HelpSearchResult

Modifier and Type	Method	Description
HelpSearchResult	HelpSearchResult.withContentAsHtml(String contentAsHtml)	Fluent setter for contentAsHtml
HelpSearchResult	HelpSearchResult.withHref(String href)	Fluent setter for href
HelpSearchResult	HelpSearchResult.withKey(String key)	Fluent setter for key
HelpSearchResult	HelpSearchResult.withKind(String kind)	Fluent setter for kind
HelpSearchResult	HelpSearchResult.withLabel(String label)	Fluent setter for label
HelpSearchResult	HelpSearchResult.withName(String name)	Fluent setter for name
HelpSearchResult	HelpSearchResult.withProcess(String process)	Fluent setter for process
HelpSearchResult	HelpSearchResult.withSearchSummary(String searchSummary)	Fluent setter for searchSummary
HelpSearchResult	HelpSearchResult.withSummary(String summary)	Fluent setter for summary
HelpSearchResult	HelpSearchResult.withTable(String table)	Fluent setter for table
HelpSearchResult	HelpSearchResult.withText(String text)	Fluent setter for text

Methods in com.kingsrook.qqq.backend.core.actions.help that return types with arguments of type HelpSearchResult

Modifier and Type	Method	Description
List<HelpSearchResult>	HelpSearchAction.collectCandidates()	Collect visible documentation, including label-only targets for navigation.
List<HelpSearchResult>	HelpSearchAction.execute(HelpSearchInput input)	Search help with the current user's metadata and table-read permissions.
static List<HelpSearchResult>	HelpSearchAction.rank(List<HelpSearchResult> candidates, String query, Integer limit)	Rank before limiting or truncating content, with deterministic tie breaks.

Method parameters in com.kingsrook.qqq.backend.core.actions.help with type arguments of type HelpSearchResult

Modifier and Type	Method	Description
static List<HelpSearchResult>	HelpSearchAction.rank(List<HelpSearchResult> candidates, String query, Integer limit)	Rank before limiting or truncating content, with deterministic tie breaks.

Uses of HelpSearchResult in com.kingsrook.qqq.middleware.javalin.specs.v1.responses

Method parameters in com.kingsrook.qqq.middleware.javalin.specs.v1.responses with type arguments of type HelpSearchResult

Modifier and Type	Method	Description
void	HelpSearchResponseV1.setResults(List<HelpSearchResult> results)	Set results from the core action.

Uses of HelpSearchResult in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components

Constructors in com.kingsrook.qqq.middleware.javalin.specs.v1.responses.components with parameters of type HelpSearchResult

Modifier	Constructor	Description
	HelpSearchResultV1(HelpSearchResult wrapped)	Wrap the action result.