Skip to content

Class: BooleanValidationSchema

Extends schema to define a boolean-specific set of validation rules that can be used.

 classDiagram
    class BooleanValidationSchema
    click BooleanValidationSchema href "../BooleanValidationSchema/"
      Schema <|-- BooleanValidationSchema
        click Schema href "../Schema/"

      BooleanValidationSchema : allowEmpty

      BooleanValidationSchema : dataType

      BooleanValidationSchema : name

Inheritance

  • Schema
    • BooleanValidationSchema

Attributes

Name Cardinality and Range Description Inheritance
allowEmpty 0..1
boolean		 If true, indicates a value must be provided direct
name 1
string		 The name of the schema rule Schema
dataType 1
string		 Indicates the expected data type for the user provided value Schema
This section is only relevant for contributors of the specification

LinkML Source

Direct

Details 
name: BooleanValidationSchema
description: Extends schema to define a boolean-specific set of validation rules that
  can be used.
from_schema: https://specification.margo.org/data-model
is_a: Schema
attributes:
  allowEmpty:
    name: allowEmpty
    description: If true, indicates a value must be provided. Default is false if
      not provided.
    from_schema: https://specification.margo.org/application-schema
    domain_of:
    - TextValidationSchema
    - BooleanValidationSchema
    - NumericIntegerValidationSchema
    - NumericDoubleValidationSchema
    - SelectValidationSchema
    range: boolean
    required: false

Induced

Details 
name: BooleanValidationSchema
description: Extends schema to define a boolean-specific set of validation rules that
  can be used.
from_schema: https://specification.margo.org/data-model
is_a: Schema
attributes:
  allowEmpty:
    name: allowEmpty
    description: If true, indicates a value must be provided. Default is false if
      not provided.
    from_schema: https://specification.margo.org/application-schema
    alias: allowEmpty
    owner: BooleanValidationSchema
    domain_of:
    - TextValidationSchema
    - BooleanValidationSchema
    - NumericIntegerValidationSchema
    - NumericDoubleValidationSchema
    - SelectValidationSchema
    range: boolean
    required: false
  name:
    name: name
    description: The name of the schema rule. This used in the [setting](#setting-attributes)
      to link the setting to the schema rule.
    from_schema: https://specification.margo.org/application-schema
    identifier: true
    alias: name
    owner: BooleanValidationSchema
    domain_of:
    - Component
    - Parameter
    - DeploymentMetadata
    - ApplicationMetadata
    - Author
    - Organization
    - Section
    - Setting
    - Schema
    - ComponentStatus
    range: string
    required: true
  dataType:
    name: dataType
    description: Indicates the expected data type for the user provided value. Accepted
      values are string, integer, double, boolean, array[string], array[integer],
      array[double], array[boolean]. At a minimum, the provided parameter value MUST
      match the schema's data type if no other validation rules are provided.
    from_schema: https://specification.margo.org/application-schema
    alias: dataType
    owner: BooleanValidationSchema
    domain_of:
    - Schema
    range: string
    required: true