AARCHMRS Schema 2.7.4

↚ Home

Values.ConditionalValue object

A ConditionalValue is a value that is present if and only if the condition property evaluates to True.

object

Properties Type Description
_meta Meta
See Meta for more information.
_type
Enum
Values.ConditionalValue
condition Traits.HasCondition
See definitions.condition in Traits.HasCondition for more information.
meaning Text

The meaning associated to this value in the context it is used.

See Text for more information.
values Valuesets.Values

The value that the parent field gets assigned when condition evaluates to True.

See Valuesets.Values for more information.
Additional Properties
Not Allowed
◊ Required
Properties marked with ◊ are required properties.
Examples
{
    "_type": "Values.ConditionalValue", 
    "condition": {
        "_type": "AST.Function", 
        "arguments": [
            {
                "_type": "AST.Identifier", 
                "value": "MY_FEAT"
            }
        ], 
        "name": "IsFeatureImplemented"
    }, 
    "values": {
        "_type": "Valuesets.Values", 
        "values": [
            {
                "_type": "Values.Value", 
                "value": "'001'", 
                "meaning": "First conditional Value"
            }, 
            {
                "_type": "Values.Value", 
                "value": "'010'", 
                "meaning": "Second conditional Value"
            }
        ]
    }
}

Schema http://json-schema.org/draft-04/schema#

{
  "additionalProperties": false,
  "info": [
    "A ConditionalValue is a value that is present if and only if the condition property evaluates to True."
  ],
  "properties": {
    "_meta": {
      "$ref": "../Meta.json"
    },
    "_type": {
      "enum": [
        "Values.ConditionalValue"
      ]
    },
    "condition": {
      "$ref": "../Traits/HasCondition.json#/definitions/condition"
    },
    "meaning": {
      "$ref": "../Text.json",
      "info": [
        "The meaning associated to this value in the context it is used."
      ]
    },
    "values": {
      "$ref": "../Valuesets/Values.json",
      "info": [
        "The value that the parent field gets assigned when condition evaluates to True."
      ]
    }
  },
  "required": [
    "condition"
  ],
  "title": "ConditionalValue",
  "type": "object",
  "examples": [
    {
      "_type": "Values.ConditionalValue",
      "condition": {
        "_type": "AST.Function",
        "arguments": [
          {
            "_type": "AST.Identifier",
            "value": "MY_FEAT"
          }
        ],
        "name": "IsFeatureImplemented"
      },
      "values": {
        "_type": "Valuesets.Values",
        "values": [
          {
            "_type": "Values.Value",
            "value": "'001'",
            "meaning": "First conditional Value"
          },
          {
            "_type": "Values.Value",
            "value": "'010'",
            "meaning": "Second conditional Value"
          }
        ]
      }
    }
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}