Class: ClauseLibraryVariableSet

Defines a type where additional variables associated to clauses and their variants can be described.

URI: common_domain_model:ClauseLibraryVariableSet

 classDiagram
    class ClauseLibraryVariableSet
    click ClauseLibraryVariableSet href "../ClauseLibraryVariableSet/"
      ClauseLibraryVariableSet : name
        
      ClauseLibraryVariableSet : value
        
      ClauseLibraryVariableSet : variableSet
        
          
    
        
        
        ClauseLibraryVariableSet --> "*" ClauseLibraryVariableSet : variableSet
        click ClauseLibraryVariableSet href "../ClauseLibraryVariableSet/"
    

        
      

Slots

Name	Cardinality and Range	Description	Inheritance
name	0..1 string	The name of the variable	direct
variableSet	* ClauseLibraryVariableSet	For some variants a table of variables is required	direct
value	0..1 string	The value for this variable	direct

Usages

used by	used in	type	used
ClauseLibraryClauseVariant	variableSet	range	ClauseLibraryVariableSet
ClauseLibraryVariableSet	variableSet	range	ClauseLibraryVariableSet

Rules

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'variableSet': {'value_presence': 'PRESENT'}}	{'value': {'value_presence': 'ABSENT'}}

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions		{'value': {'value_presence': 'PRESENT'}}

Rule Applied	Preconditions	Postconditions	Elseconditions
slot_conditions	{'value': {'value_presence': 'PRESENT'}}

Comments

• Rosetta condition VariableSetNesting is not stated in LinkML: if variableSet -> variableSet exists then variableSet -> variableSet -> variableSet is absent

Identifier and Mapping Information

Schema Source

• from schema: https://w3id.org/lmodel/common-domain-model

Mappings

Mapping Type	Mapped Value
self	common_domain_model:ClauseLibraryVariableSet
native	common_domain_model:ClauseLibraryVariableSet

LinkML Source

Direct

name: ClauseLibraryVariableSet
description: Defines a type where additional variables associated to clauses and their
  variants can be described.
comments:
- 'Rosetta condition VariableSetNesting is not stated in LinkML: if variableSet ->
  variableSet exists then variableSet -> variableSet -> variableSet is absent'
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- name
slot_usage:
  name:
    name: name
    description: The name of the variable.
    range: string
attributes:
  variableSet:
    name: variableSet
    description: For some variants a table of variables is required. To support this
      use case we need to be able to specify variables within variables. Including
      a variable set here gives us infinite nesting opportunities - realistically
      we are only ever expecting that a table would need to be defined for any particular
      clause, so we would expect two levels of nesting as a maximum i.e. variableSet->variableSet->name/value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_clauselibrary
    domain_of:
    - ClauseLibraryClauseVariant
    - ClauseLibraryVariableSet
    - DirectionRatingMultiplier
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - ThresholdRatingsBased
    range: ClauseLibraryVariableSet
    multivalued: true
  value:
    name: value
    description: The value for this variable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_clauselibrary
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: string
rules:
- preconditions:
    slot_conditions:
      variableSet:
        name: variableSet
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      name:
        name: name
        value_presence: ABSENT
      value:
        name: value
        value_presence: ABSENT
  description: 'VariableSetExists: If we have a variableSet then we must not have
    any name/value pairs at this level.'
- preconditions:
    slot_conditions:
      name:
        name: name
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  description: 'NameMustExist: If we have a name then we must also have a value.'
- preconditions:
    slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      name:
        name: name
        value_presence: PRESENT
  description: 'ValueMustExist: If we have a value then we must also have a name.'

Induced

name: ClauseLibraryVariableSet
description: Defines a type where additional variables associated to clauses and their
  variants can be described.
comments:
- 'Rosetta condition VariableSetNesting is not stated in LinkML: if variableSet ->
  variableSet exists then variableSet -> variableSet -> variableSet is absent'
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  name:
    name: name
    description: The name of the variable.
    range: string
attributes:
  variableSet:
    name: variableSet
    description: For some variants a table of variables is required. To support this
      use case we need to be able to specify variables within variables. Including
      a variable set here gives us infinite nesting opportunities - realistically
      we are only ever expecting that a table would need to be defined for any particular
      clause, so we would expect two levels of nesting as a maximum i.e. variableSet->variableSet->name/value.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_clauselibrary
    owner: ClauseLibraryVariableSet
    domain_of:
    - ClauseLibraryClauseVariant
    - ClauseLibraryVariableSet
    - DirectionRatingMultiplier
    - LegacyIndependentAmountRatingsBased
    - MinimumTransferAmountRatingsBased
    - ThresholdRatingsBased
    range: ClauseLibraryVariableSet
    multivalued: true
  value:
    name: value
    description: The value for this variable.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_legaldocumentation_clauselibrary
    owner: ClauseLibraryVariableSet
    domain_of:
    - DatedValue
    - Schedule
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AccrualFactor
    - AdjustmentFactor
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    range: string
  name:
    name: name
    description: The name of the variable.
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: ClauseLibraryVariableSet
    domain_of:
    - TaxonomyValue
    - BusinessUnit
    - LegalEntity
    - Party
    - IndexBase
    - Resource
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - ClauseLibraryVariableSet
    - CSAMinimumTransferAmountVariableSet
    - CSAThresholdVariableSet
    - CsaAdditionalTerminationEvent
    range: string
rules:
- preconditions:
    slot_conditions:
      variableSet:
        name: variableSet
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      name:
        name: name
        value_presence: ABSENT
      value:
        name: value
        value_presence: ABSENT
  description: 'VariableSetExists: If we have a variableSet then we must not have
    any name/value pairs at this level.'
- preconditions:
    slot_conditions:
      name:
        name: name
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  description: 'NameMustExist: If we have a name then we must also have a value.'
- preconditions:
    slot_conditions:
      value:
        name: value
        value_presence: PRESENT
  postconditions:
    slot_conditions:
      name:
        name: name
        value_presence: PRESENT
  description: 'ValueMustExist: If we have a value then we must also have a name.'