The Predicate tree root uses an [AND]{@link BooleanOperator#AND} operator to combine the Predicates.
a CategoryFactory instance. This dependency is optional. It is required if we want to load predicate filter from saved metadata
Filter that should be applied to the view when no searching is being performed. Injected trough the NAE_BASE_FILTER injection token.
Holds the Filter that is currently being applied to the view.
Filter that is applied to the view, even if the user doesn't search anything.
Holds the full text Filter if set, undefined otherwise.
The rootPredicate uses this stream to notify the search service about changes to the held query
The index of a removed Predicate is emmited into this stream
Holds the Predicate tree root for user search queries.
the Filter that is currently applied to the view
an Observable that updates every time the active Filter changes.
true if a filter other than the base filter is currently applied.
Returns false if only the base filter is currently applied.
a copy of the base filter
the type of the filter held in this search service instance
true if any visible predicates are applied.
Returns false if there are no predicates, or if there are only hidden predicates applied
whether the search service is currently loading its state from metadata or not.
See [loadFromMetadata()]{@link SearchService#loadFromMetadata}
an Observable that emits true if the search service is currently loading its state from metadata,
emits false otherwise.
See [loadFromMetadata()]{@link SearchService#loadFromMetadata}
an Observable that emits whenever the root predicates query changes
an Observable that emits the index of the removed predicate whenever a predicate is removed
the root predicate of the search service, that can be used to generate search requests with custom queries
Adds a new hidden branch of the predicate tree with a singular leaf node containing the provided Query.
This can be used to add predicates to the search tree (think header search), which can be made visible and editable in the search GUI later.
the generator that is in such state, that it generates the Query, that should be added as branch/leaf. If the generator doesn't currently generate a query a node with an empty query will be added.
Adds a Predicate to the Predicate root and updates the active Filter.
Predicates added this way will not be visible in the search GUI. If you want to make sure your predicates are visible (and editable) use the [addGeneratedLeafPredicate()]{@link SearchService#addGeneratedLeafPredicate} method instead.
Predicate that should be added to the search queries.
the index of the added Predicate
Clears the full text filter (if set). If the full text filter is not set, does nothing.
Removes all Predicate objects that contribute to the search. Updates the active Filter if it was affected.
whether the hidden predicates should be cleared as well
an Array of filter text segments that correspond to the currently displayed completed predicates
undefined if the predicate tree contains no complete query.
Otherwise returns the serialized form of the completed queries in the predicate tree.
Replaces the current predicate filter by the one corresponding to the provided generator metadata.
The CategoryFactory instance must be provided for this service if we want to use this method. Logs an error and does nothing.
The filterType of this search service must match the filterType of the provided metadata. Otherwise an error is thrown.
the serialized state of the predicate tree that should be restored to this search service
Removes the Predicate object from the provided index. If the index is invalid does nothing. Updates the the active Filter if the Predicate tree was affected.
index of the Predicate that should be removed
whether the input, that corresponds to the predicate should be cleared
Adds a Filter with the [fullText]{@link CaseSearchRequestBody#fullText} attribute set to the provided value. If full text filter is already set, it will be replaced.
value that should be searched on all full text fields
Shows the predicates with the given ids. Skips ids that don't exist.
the ids of the predicates that should be shown.
Reads the current query from the predicate tree, combines it with the base Filter and full text Filter (if set) and updates the active Filter.
Loads whole new filter and search cases/tasks based on this filter
whole new filter that should be used for search
Generated using TypeDoc
Holds information about the filter that is currently applied to the view component, that provides this services.