Back to bricks list
Introduction
Technical Documentation
Other Classes
Scenario ScenarioSearchBuilder SearchBuilder
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

Parameters:
NameTypeDefault valueDescription
process_typing_namestr
Return type:
ScenarioSearchBuilder
ADD_EXPRESSION
Parameters:
NameTypeDefault valueDescription
expressionExpression
Return type:
SearchBuilderType
ADD_FOLDER_FILTER

Filter the search query by a specific folder

Parameters:
NameTypeDefault valueDescription
folder_idstr
Return type:
ScenarioSearchBuilder
ADD_IS_ARCHIVED_FILTER

Filter the search query by a specific archived status

Parameters:
NameTypeDefault valueDescription
is_archivedbool
Return type:
ScenarioSearchBuilder
ADD_JOIN
Parameters:
NameTypeDefault valueDescription
tableType
onExpression
Return type:
SearchBuilderType
ADD_ORDERING
Parameters:
NameTypeDefault valueDescription
orderOrdering
Return type:
SearchBuilderType
ADD_SEARCH_PARAMS
Parameters:
NameTypeDefault valueDescription
searchSearchParams
Return type:
SearchBuilderType
ADD_STATUS_FILTER

Filter the search query by a specific status

Parameters:
NameTypeDefault valueDescription
statusScenarioStatus
Return type:
ScenarioSearchBuilder
ADD_TAG_FILTER
Parameters:
NameTypeDefault valueDescription
tagTag
value_operatorSearchOperator SearchOperator.EQ
error_if_key_not_existsbool False
Return type:
SearchBuilderType
ADD_TITLE_FILTER

Filter the search query where title contains the name

Parameters:
NameTypeDefault valueDescription
titlestr
Return type:
ScenarioSearchBuilder
CONVERT_FILTER_TO_EXPRESSION
Parameters:
NameTypeDefault valueDescription
filter_SearchFilterCriteria
Return type:
Expression
CONVERT_ORDER_TO_PEEWEE_ORDERING

Convert a search order criteria to a peewee ordering

Parameters:
NameTypeDefault valueDescription
orderSearchSortCriteria
Return type:
Ordering
CONVERT_VALUE

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

Parameters:
NameTypeDefault valueDescription
fieldField
valueAny
Return type:
Any
SEARCH_ALL
Return type:
List
SEARCH_PAGE
Parameters:
NameTypeDefault valueDescription
pageint 0
number_of_items_per_pageint 20
Return type:
Paginator
SET_ORDERING
Parameters:
NameTypeDefault valueDescription
ordersList
Return type:
SearchBuilderType