gws.core.types.IModelField

class documentation

class IModelField(INode, Protocol): (source)

Known subclasses: gws.base.model.field.Object, gws.base.model.related_field.Object, gws.base.model.scalar_field.Object

View In Hierarchy

Undocumented

Method	`after_create`	Undocumented
Method	`after_create_related`	Undocumented
Method	`after_delete`	Undocumented
Method	`after_select`	Undocumented
Method	`after_update`	Undocumented
Method	`before_create`	Undocumented
Method	`before_create_related`	Undocumented
Method	`before_delete`	Undocumented
Method	`before_select`	Undocumented
Method	`before_update`	Undocumented
Method	`describe`	Undocumented
Method	`do_init`	Undocumented
Method	`do_init_related`	Undocumented
Method	`do_validate`	Undocumented
Method	`find_relatable_features`	Undocumented
Method	`from_props`	Undocumented
Method	`from_record`	Undocumented
Method	`prop_to_python`	Undocumented
Method	`python_to_prop`	Undocumented
Method	`python_to_raw`	Undocumented
Method	`raw_to_python`	Undocumented
Method	`related_models`	Undocumented
Method	`to_props`	Undocumented
Method	`to_record`	Undocumented
Class Variable	`attributeType`	Undocumented
Class Variable	`isAuto`	Undocumented
Class Variable	`isPrimaryKey`	Undocumented
Class Variable	`isRequired`	Undocumented
Class Variable	`isUnique`	Undocumented
Class Variable	`model`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`supportsFilterSearch`	Undocumented
Class Variable	`supportsGeometrySearch`	Undocumented
Class Variable	`supportsKeywordSearch`	Undocumented
Class Variable	`title`	Undocumented
Class Variable	`validators`	Undocumented
Class Variable	`values`	Undocumented
Class Variable	`widget`	Undocumented

Inherited from INode:

Method	`activate`	Undocumented
Method	`cfg`	Undocumented
Method	`closest`	Undocumented
Method	`configure`	Undocumented
Method	`create_child`	Undocumented
Method	`create_child_if_configured`	Undocumented
Method	`create_children`	Undocumented
Method	`find_all`	Undocumented
Method	`find_first`	Undocumented
Method	`post_configure`	Undocumented
Method	`pre_configure`	Undocumented
Class Variable	`children`	Undocumented
Class Variable	`config`	Undocumented
Class Variable	`extName`	Undocumented
Class Variable	`extType`	Undocumented
Class Variable	`parent`	Undocumented
Class Variable	`root`	Undocumented
Class Variable	`uid`	Undocumented

Inherited from IObject (via INode):

Method	`props`	Undocumented
Class Variable	`permissions`	Undocumented

def after_create(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.plugin.model_field.related_linked_feature_list.Object, gws.plugin.model_field.related_linked_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object

Undocumented

def after_create_related(self, to_feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.plugin.model_field.related_feature.Object, gws.plugin.model_field.related_feature.Object, gws.plugin.model_field.related_linked_feature_list.Object, gws.plugin.model_field.related_linked_feature_list.Object

Undocumented

def after_delete(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.plugin.model_field.related_multi_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object

Undocumented

def after_select(self, features: list[IFeature], mc: ModelContext): (source) ¶

overridden in gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.file.Object, gws.plugin.model_field.related_feature.Object, gws.plugin.model_field.related_feature.Object, gws.plugin.model_field.related_linked_feature_list.Object, gws.plugin.model_field.related_linked_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object

Undocumented

def after_update(self, feature: IFeature, mc: ModelContext): (source) ¶

Undocumented

def before_create(self, feature: IFeature, mc: ModelContext): (source) ¶

Undocumented

def before_create_related(self, to_feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.plugin.model_field.related_multi_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object

Undocumented

def before_delete(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.plugin.model_field.related_multi_feature_list.Object, gws.plugin.model_field.related_multi_feature_list.Object

Undocumented

def before_select(self, mc: ModelContext): (source) ¶

overridden in gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.file.Object

Undocumented

def before_update(self, feature: IFeature, mc: ModelContext): (source) ¶

Undocumented

def describe(self) -> Optional[ColumnDescription]: (source) ¶

overridden in gws.base.model.field.Object

Undocumented

def do_init(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.related_feature.Object, gws.plugin.model_field.related_feature.Object

Undocumented

def do_init_related(self, to_feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.related_field.Object, gws.base.model.related_field.Object

Undocumented

def do_validate(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.field.Object

Undocumented

def find_relatable_features(self, search: SearchQuery, mc: ModelContext) -> list[IFeature]: (source) ¶

overridden in gws.base.model.field.Object, gws.base.model.related_field.Object

Undocumented

def from_props(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.related_field.Object, gws.base.model.related_field.Object, gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.file.Object

Undocumented

def from_record(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.file.Object

Undocumented

def prop_to_python(self, feature: IFeature, value, mc: ModelContext): (source) ¶

overridden in gws.base.model.field.Object, gws.plugin.model_field.bool.Object, gws.plugin.model_field.geometry.Object

Undocumented

def python_to_prop(self, feature: IFeature, value, mc: ModelContext): (source) ¶

overridden in gws.base.model.field.Object, gws.plugin.model_field.geometry.Object

Undocumented

def python_to_raw(self, feature: IFeature, value, mc: ModelContext): (source) ¶

overridden in gws.base.model.field.Object, gws.plugin.model_field.geometry.Object

Undocumented

def raw_to_python(self, feature: IFeature, value, mc: ModelContext): (source) ¶

overridden in gws.base.model.field.Object, gws.plugin.model_field.geometry.Object

Undocumented

def related_models(self) -> list[IModel]: (source) ¶

overridden in gws.base.model.field.Object, gws.base.model.related_field.Object

Undocumented

def to_props(self, feature: IFeature, mc: ModelContext): (source) ¶

Undocumented

def to_record(self, feature: IFeature, mc: ModelContext): (source) ¶

overridden in gws.base.model.scalar_field.Object, gws.base.model.scalar_field.Object, gws.plugin.model_field.file.Object

Undocumented

attributeType: AttributeType = (source) ¶

Undocumented

isAuto: bool = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

isPrimaryKey: bool = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

isRequired: bool = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

isUnique: bool = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

model: IModel = (source) ¶

overridden in gws.base.model.field.Object, gws.base.model.related_field.Object

Undocumented

name: str = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

supportsFilterSearch: bool = (source) ¶

Undocumented

supportsGeometrySearch: bool = (source) ¶

overridden in gws.plugin.model_field.geometry.Object, gws.plugin.model_field.geometry.Object

Undocumented

supportsKeywordSearch: bool = (source) ¶

overridden in gws.plugin.model_field.text.Object, gws.plugin.model_field.text.Object

Undocumented

title: str = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

validators: list[IModelValidator] = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

values: list[IModelValue] = (source) ¶

overridden in gws.base.model.field.Object

Undocumented

widget: Optional[IModelWidget] = (source) ¶

overridden in gws.base.model.field.Object, gws.base.model.related_field.Object, gws.plugin.model_field.bool.Object, gws.plugin.model_field.date.Object, gws.plugin.model_field.datetime.Object, gws.plugin.model_field.float.Object, gws.plugin.model_field.geometry.Object, gws.plugin.model_field.integer.Object, gws.plugin.model_field.text.Object, gws.plugin.model_field.time.Object

Undocumented