ResourceSearchBuilder - gws_core

Search build for the resource model

:param SearchBuilder: [description] :type SearchBuilder: [type]

Attributes

entity_type: EntityType

Functions

__INIT__

Create a search build to make dynamic search

ADD_EXPRESSION

Parameters:

Name	Type	Default value	Description
expression	`Expression`

Return type:

SearchBuilderType

ADD_FLAGGED_FILTER

Filter the search query by a specific flag

Parameters:

Name	Type	Default value	Description
flagged	`bool`

Return type:

ResourceSearchBuilder

ADD_FOLDER_FILTER

Filter the search query by a specific folder

Parameters:

Name	Type	Default value	Description
folder_id	`str`

Return type:

ResourceSearchBuilder

ADD_IS_ARCHIVED_FILTER

Filter the search query by a specific archived status

Parameters:

Name	Type	Default value	Description
is_archived	`bool`

Return type:

ResourceSearchBuilder

ADD_JOIN

Parameters:

Name	Type	Default value	Description
table	`Type`
on	`Expression`

Return type:

SearchBuilderType

ADD_NAME_FILTER

Filter the search query by a specific name

Parameters:

Name	Type	Default value	Description
name	`str`

Return type:

ResourceSearchBuilder

ADD_ORDERING

Parameters:

Name	Type	Default value	Description
order	`Ordering`

Return type:

SearchBuilderType

ADD_ORIGIN_FILTER

Filter the search query by a specific origin

Parameters:

Name	Type	Default value	Description
origin	`ResourceOrigin`

Return type:

ResourceSearchBuilder

ADD_PARENT_FILTER

Filter the search query by a specific parent

Parameters:

Name	Type	Default value	Description
parent_id	`str`

Return type:

ResourceSearchBuilder

ADD_RESOURCE_TYPE_FILTER

Filter the search query by a specific resource type

Parameters:

Name	Type	Default value	Description
resource_type	`Type`

Return type:

ResourceSearchBuilder

ADD_RESOURCE_TYPING_NAME_FILTER

Filter the search query by a specific resource typing name

Parameters:

Name	Type	Default value	Description
resource_typing_name	`str`

Return type:

ResourceSearchBuilder

ADD_SEARCH_PARAMS

Parameters:

Name	Type	Default value	Description
search	`SearchParams`

Return type:

SearchBuilderType

ADD_TAG_FILTER

Parameters:

Name	Type	Default value
tag	`Tag`
value_operator	`SearchOperator`	SearchOperator.EQ
error_if_key_not_exists	`bool`	False

Return type:

SearchBuilderType

BUILD_SEARCH

Return type:

ModelSelect

CONVERT_FILTER_TO_EXPRESSION

Parameters:

Name	Type	Default value	Description
filter_	`SearchFilterCriteria`

Return type:

Expression

CONVERT_ORDER_TO_PEEWEE_ORDERING

Convert a search order criteria to a peewee ordering

Parameters:

Name	Type	Default value	Description
order	`SearchSortCriteria`

Return type:

Ordering

CONVERT_VALUE

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

Parameters:

Name	Type	Default value	Description
field	`Field`
value	`Any`

Return type:

Any

SEARCH_ALL

Return type:

List

SEARCH_PAGE

Parameters:

Name	Type	Default value	Description
page	`int`	0
number_of_items_per_page	`int`	20

Return type:

Paginator

SET_ORDERING

Parameters:

Name	Type	Default value	Description
orders	`List`

Return type:

SearchBuilderType