Uses of Class
com.funnelback.publicui.search.model.transaction.SearchTransaction

Packages that use SearchTransaction

Package	Description
com.funnelback.publicui.search.model.collection.facetednavigation	Provides classes representing the faceted navigation configuration, as in faceted_navigation.cfg.
com.funnelback.publicui.search.model.collection.facetednavigation.impl	Provides facets definition implementations (GScopeItem, Metadata field fill, etc.).
com.funnelback.publicui.search.model.curator.action	Provides classes representing Curator system actions.
com.funnelback.publicui.search.model.curator.config	Provides classes representing the Curator system's configuration, including actions (what should happen) and triggers (when should it happen).
com.funnelback.publicui.search.model.curator.trigger	Provides classes representing Curator system triggers (controls when Action objects are executed).
com.funnelback.publicui.search.model.transaction	Provides classes used for a search transaction, from the input parameters to the search results.

Uses of SearchTransaction in com.funnelback.publicui.search.model.collection.facetednavigation

Methods in com.funnelback.publicui.search.model.collection.facetednavigation with parameters of type SearchTransaction

Modifier and Type	Method	Description
abstract java.util.List<CategoryValueComputedDataHolder>	CategoryDefinition.computeData(SearchTransaction st, FacetDefinition fdef)
java.util.List<Facet.CategoryValue>	CategoryDefinition.computeValues(SearchTransaction st, FacetDefinition fdef)	Generates a list of corresponding Facet.CategoryValue by applying this category type rule over a ResultPacket.
protected CategoryDefinition.FacetSearchData	CategoryDefinition.getFacetSearchData(SearchTransaction st, FacetDefinition facetDefinition)
boolean	FacetedNavigationProperties.useDedicatedExtraSearchForCounts(FacetDefinition facet, SearchTransaction searchTransaction)	Do we need to run a dedicated extra search to work out the counts? For a selected facet that is a OR type facet we do because the result set could be expanded when selected.
boolean	FacetedNavigationProperties.useScopedSearchWithFacetDisabledForCounts(FacetDefinition facet, SearchTransaction searchTransaction)
boolean	FacetedNavigationProperties.useScopedSearchWithFacetDisabledForValues(FacetDefinition facet, SearchTransaction searchTransaction)
boolean	FacetedNavigationProperties.useUnscopedQueryForCounts(FacetDefinition facet, SearchTransaction searchTransaction)	Can we use the counts from the unscoped query? We can do this for single select unselect other facets as the count from the unscoped query will be the same as selecting any value which will first remove any facets (like the unscoped query) and then apply a single constraint (which we can count from the unscoped query).

Uses of SearchTransaction in com.funnelback.publicui.search.model.collection.facetednavigation.impl

Methods in com.funnelback.publicui.search.model.collection.facetednavigation.impl with parameters of type SearchTransaction

Modifier and Type	Method	Description
java.util.List<CategoryValueComputedDataHolder>	AllDocumentsFill.computeData(SearchTransaction st, FacetDefinition fdef)
java.util.List<CategoryValueComputedDataHolder>	CollectionFill.computeData(SearchTransaction st, FacetDefinition fdef)
java.util.List<CategoryValueComputedDataHolder>	DateFieldFill.computeData(SearchTransaction st, FacetDefinition facetDefinition)
java.util.List<CategoryValueComputedDataHolder>	GScopeItem.computeData(SearchTransaction st, FacetDefinition facetDefinition)
java.util.List<CategoryValueComputedDataHolder>	MetadataFieldFill.computeData(SearchTransaction st, FacetDefinition facetDefinition)
java.util.List<CategoryValueComputedDataHolder>	URLFill.computeData(SearchTransaction st, FacetDefinition facetDefinition)
java.util.Map<FacetURL,java.lang.Integer>	URLFill.convertUrlCountsToFacetUrlAndCount(SearchTransaction st)	Takes the URL counts from padre and convert them into a FacetUrl and count If URLs flatten down to what is the same (e.g.
boolean	AllDocumentsFill.isSelected(SearchTransaction st)

Uses of SearchTransaction in com.funnelback.publicui.search.model.curator.action

Methods in com.funnelback.publicui.search.model.curator.action with parameters of type SearchTransaction

Modifier and Type	Method	Description
(package private) static void	RemoveUrls.addUrlsStringToRemoveList(SearchTransaction searchTransaction, java.lang.String urlsToRemove)	Add URLs for removal to the searchTranaction.
void	AddQueryTerm.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Add the specified query term to the user's query via the 's' parameter.
void	DisplayMessage.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Add the given message to the curator model's exhibits in the given searchTransaction.
void	DisplayProperties.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Adds the action's properties object to the curator model's exhibits.
void	DisplayUrlAdvert.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Adds the action's URL advert object to the curator model's exhibits and removes any result with the same URL from the main search results.
void	GroovyAction.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Performs the desired action (by calling performAction on an instance of the specified Groovy class).
void	GroovyActionInterface.performAction(SearchTransaction searchTransaction, Action.Phase phase, java.util.Map<java.lang.String,java.lang.Object> properties)	Perform the desired action by modifying the passed searchTransaction.
void	PromoteUrls.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Appends this instance's urlsToPromote to the list of URLs for promotion which will be given to padre.
void	RemoveUrls.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Appends this instance's urlsToRemove to the list of URLs for removal which will be given to padre.
void	ReplaceQueryTerm.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Replace occurrences of target with replacement within the question's query and metaParameters.
void	SetQuery.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Replace occurrences of target with replacement within the question's query and metaParameters.
void	TransformQuery.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Replace occurrences of target with replacement within the question's query and metaParameters.

Uses of SearchTransaction in com.funnelback.publicui.search.model.curator.config

Methods in com.funnelback.publicui.search.model.curator.config with parameters of type SearchTransaction

Modifier and Type	Method	Description
boolean	Trigger.activatesOn(SearchTransaction searchTransaction)
static boolean	CuratorConfig.isCuratorActive(SearchTransaction searchTransaction)	Determines, based on the given searchTransaction, whether the curator system should be activated.
void	Action.performAction(SearchTransaction searchTransaction, Action.Phase phase)	Perform the defined action by modifying the searchTransaction object.
void	ActionSet.performActions(SearchTransaction searchTransaction, Action.Phase phase)	Perform any actions within the set should be run in the given phase.
static java.lang.String	Trigger.queryToMatchAgainst(SearchTransaction searchTransaction)	Reads FrontEnd.ModernUi.Curator.QUERY_PARAMETER_PATTERN, finds matching input parameters and returns a single query for matching against.

Uses of SearchTransaction in com.funnelback.publicui.search.model.curator.trigger

Methods in com.funnelback.publicui.search.model.curator.trigger with parameters of type SearchTransaction

Modifier and Type	Method	Description
boolean	AllQueryWordsTrigger.activatesOn(SearchTransaction searchTransaction)	Check the given searchTransaction to see if the query contains all the required words for this trigger.
boolean	AndTrigger.activatesOn(SearchTransaction searchTransaction)	Check each 'sub' trigger in turn to see if it activates on the given searchTransaction, and return true only if they all activate (otherwise return false).
boolean	CountryNameTrigger.activatesOn(SearchTransaction searchTransaction)	Check whether the given searchTransaction originates from a country listed in targetCountries.
boolean	DateRangeTrigger.activatesOn(SearchTransaction searchTransaction)	Check whether the server's current time falls between the startDate and endDate, and return true if it does and false otherwise.
boolean	ExactQueryTrigger.activatesOn(SearchTransaction searchTransaction)	Return true if the query within searchTransaction exactly matches the triggerQuery (subject to ignoreCase), otherwise return false.
boolean	FacetSelectionTrigger.activatesOn(SearchTransaction searchTransaction)	Check whether the given searchTransaction contains a selected category in the facetName facet which matches (as defined by matchType) the categoryValue parameter.
boolean	GroovyTrigger.activatesOn(SearchTransaction searchTransaction)	Check the given searchTransaction to see if the trigger activates on this request.
boolean	GroovyTriggerInterface.activatesOn(SearchTransaction searchTransaction, java.util.Map<java.lang.String,java.lang.Object> properties)
boolean	NotAnyTrigger.activatesOn(SearchTransaction searchTransaction)	Check each 'sub' trigger in turn to see if it activates on the given searchTransaction, and return true only if none of them activate (otherwise return false).
boolean	OrTrigger.activatesOn(SearchTransaction searchTransaction)	Check each 'sub' trigger in turn to see if it activates on the given searchTransaction, and return true only if one of them does (otherwise return false).
boolean	QueryRegularExpressionTrigger.activatesOn(SearchTransaction searchTransaction)	Return true if the query within the searchTransaction matches the triggerPatter, otherwise return false
boolean	QuerySubstringTrigger.activatesOn(SearchTransaction searchTransaction)	Return true if the current query in searchTransaction contains the triggerSubstring, otherwise return false.
boolean	RequestParameterTrigger.activatesOn(SearchTransaction searchTransaction)	Check whether the given searchTransaction contains a parameter of the given name which matches (as defined by matchType) the value.
boolean	UserSegmentTrigger.activatesOn(SearchTransaction searchTransaction)	Check whether the given searchTransaction originates from a country listed in targetCountries.

Uses of SearchTransaction in com.funnelback.publicui.search.model.transaction

Fields in com.funnelback.publicui.search.model.transaction with type parameters of type SearchTransaction

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,SearchTransaction>	SearchTransaction.extraSearches	Any additional extra search transactions performed during this transaction.
private java.util.Optional<SearchTransaction>	SearchTransaction.parentTransaction	Holds the parent search transaction from which this search transaction was created under.

Methods in com.funnelback.publicui.search.model.transaction that return types with arguments of type SearchTransaction

Modifier and Type	Method	Description
java.util.Map<java.lang.String,SearchTransaction>	SearchTransaction.getExtraSearches()	Any additional extra search transactions performed during this transaction.
java.util.Optional<SearchTransaction>	SearchTransaction.getParentTransaction()	Holds the parent search transaction from which this search transaction was created under.

Methods in com.funnelback.publicui.search.model.transaction with parameters of type SearchTransaction

Modifier and Type	Method	Description
static boolean	SearchTransactionUtils.hasCollection(SearchTransaction st)	Checks that a transaction has a question which has a collection.
static boolean	SearchTransactionUtils.hasQuery(SearchTransaction st)	Checks that a transaction has a question which has query.
static boolean	SearchTransactionUtils.hasQueryAndCollection(SearchTransaction st)	Checks that a transaction has question which has a query and a collection.
static boolean	SearchTransactionUtils.hasQuestion(SearchTransaction st)	Checks that a transaction has a question.
static boolean	SearchTransactionUtils.hasResponse(SearchTransaction st)	Checks that a transaction has a response.
static boolean	SearchTransactionUtils.hasResultPacket(SearchTransaction st)	Checks that a transaction has a response which has a result packet
static boolean	SearchTransactionUtils.hasResults(SearchTransaction st)	Checks that a transaction has a response which has results.
static boolean	SearchTransactionUtils.hasSession(SearchTransaction st)	Checks that a transaction has session data
void	TransactionFacetedNavigationConfigHelper.updateTheFacetConfigToUse(SearchTransaction st, FacetedNavigationConfig facetedNavigationConfig)	Updates the search transaction so that the given faceted nav config is used.