Class HelpSearchAction

java.lang.Object

com.kingsrook.qqq.backend.core.actions.help.HelpSearchAction

public class HelpSearchAction
extends Object

Ranked help search shared by UI clients and the assistant.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LIMIT
static final int	MAX_LIMIT
static final int	MAX_TERMS

Constructor Summary

Constructors

Constructor	Description
HelpSearchAction()

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

MAX_LIMIT

public static final int MAX_LIMIT

See Also:

• Constant Field Values

MAX_TERMS

public static final int MAX_TERMS

See Also:

• Constant Field Values

Constructor Details

HelpSearchAction

public HelpSearchAction()

Method Details

execute

public List<HelpSearchResult> execute(HelpSearchInput input)
                               throws QException

Search help with the current user's metadata and table-read permissions.

Throws:

QException

collectCandidates

public List<HelpSearchResult> collectCandidates()
                                         throws QException

Collect visible documentation, including label-only targets for navigation.

Throws:

QException

terms

public static Set<String> terms(String query)
                         throws QBadRequestException

Tokenization preserves the assistant's existing ten-term contract.

Throws:

QBadRequestException

rank

public static List<HelpSearchResult> rank(List<HelpSearchResult> candidates,
 String query,
 Integer limit)
                                   throws QBadRequestException

Rank before limiting or truncating content, with deterministic tie breaks.

Throws:

QBadRequestException