gws_core

Introduction
Getting Started
Developer guide
Release
Architecture
CLI
Technical documentations
Version

ScenarioSearchBuilder

Search builder that support search on tags

:param SearchBuilder: description :type SearchBuilder: type

Attributes
entity_type: EntityType
Functions
__init__

Create a search build to make dynamic search

add_contains_process_filter

Filter the search query to scenarios that contains a specific process

process_typing_name : str
Return type : ScenarioSearchBuilder
add_expression
expression : Expression
Return type : SearchBuilderType
add_folder_filter

Filter the search query by a specific folder

folder_id : str
Return type : ScenarioSearchBuilder
add_is_archived_filter

Filter the search query by a specific archived status

is_archived : bool
Return type : ScenarioSearchBuilder
add_join
table : Type
on : Expression
Return type : SearchBuilderType
add_ordering
order : Ordering
Return type : SearchBuilderType
add_search_params
search : SearchParams
Return type : SearchBuilderType
add_status_filter

Filter the search query by a specific status

status : ScenarioStatus
Return type : ScenarioSearchBuilder
add_tag_filter
tag : Tag
value_operator : SearchOperator - SearchOperator.EQ
error_if_key_not_exists : bool - False
Return type : SearchBuilderType
add_title_filter

Filter the search query where title contains the name

title : str
Return type : ScenarioSearchBuilder
convert_filter_to_expression
filter_ : SearchFilterCriteria
Return type : Expression
convert_order_to_peewee_ordering

Convert a search order criteria to a peewee ordering

order : SearchSortCriteria
Return type : Ordering
convert_value

Method to convert the search value (or values) to type of field

field : Field
value : Any
Return type : Any
search_all
Return type : List
search_page
page : int - 0
number_of_items_per_page : int - 20
Return type : Paginator
set_ordering
orders : List
Return type : SearchBuilderType