construct::opal::DefinitionValidateTask

Validate one definition record and return each finding with its editor tab and line.

Declared in src/libs/libconstruct/construct/opal/DefinitionValidateTask.hpp
Inherits construct::opal::ConstructQueryTask
Group construct

Detailed description

construct-definition-editor §DUO-3. The task runs the record validator of the editor (DefinitionRecordValidator, §DUD-6), so a record that the editor accepts is a record that this task accepts. The validator has no widget, so the task runs in a headless node too.

It takes the record in one of two forms:

- definitionId: the record text of a definition that the document resolves, built-in, library or scene, as construct.definition.get returns it in source. - source: a record text, for example one that a model is about to give to construct.definition.add or update.

It returns diagnostics, a JSON list of tab, line, severity, message, and state, the state of the editor's validation title.

See also DefinitionGetTask, DefinitionAddTask, DefinitionUpdateTask.