Class: Parameter
Parameters provide a mechanism for the dynamic assignment of value(s) in a control.
URI: [oscal:Parameter](https://w3id.org/lmodel/oscal/Parameter)
[TokenType](TokenType.md) | A unique identifier for the parameter | direct | | [_class](_class.md) | 0..1
[TokenType](TokenType.md) | A textual label that provides a characterization of the type, purpose, use or... | direct | | [depends_on](depends_on.md) | 0..1
[TokenType](TokenType.md) | (deprecated) Another parameter invoking this one | direct | | [label](label.md) | 0..1
[MarkupLineType](MarkupLineType.md) | A short, placeholder name for the parameter, which can be used as a substitut... | direct | | [usage](usage.md) | 0..1
[MarkupMultilineType](MarkupMultilineType.md) | Describes the purpose and use of a parameter | direct | | [constraints](constraints.md) | *
[ParameterConstraint](ParameterConstraint.md) | A formal or informal expression of a constraint or test | direct | | [guidelines](guidelines.md) | *
[ParameterGuideline](ParameterGuideline.md) | A prose statement that provides a recommendation for the use of a parameter | direct | | [values](values.md) | *
[String](String.md) | A parameter value or set of values | direct | | [select](select.md) | 0..1
[ParameterSelection](ParameterSelection.md) | Presenting a choice among alternatives | direct | | [remarks](remarks.md) | 0..1
[MarkupMultilineType](MarkupMultilineType.md) | Additional commentary about the containing object | [OscalCommon](OscalCommon.md) | | [props](props.md) | *
[ParameterProperty](ParameterProperty.md) | A list of properties | [HasPropsAndLinks](HasPropsAndLinks.md) | | [links](links.md) | *
[Link](Link.md) | A list of links | [HasPropsAndLinks](HasPropsAndLinks.md) | ## Usages | used by | used in | type | used | | --- | --- | --- | --- | | [Catalog](Catalog.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Group](Group.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Control](Control.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [ProfileGroup](ProfileGroup.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Addition](Addition.md) | [params](params.md) | range | [Parameter](Parameter.md) | ## Rules ### values-xor-select | Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------| | slot_conditions |```{'values': {'value_presence': 'PRESENT'}}``` |```{'select': {'value_presence': 'ABSENT'}}``` | | ### select-xor-values | Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------| | slot_conditions |```{'select': {'value_presence': 'PRESENT'}}``` |```{'values': {'value_presence': 'ABSENT'}}``` | | ## In Subsets * [OscalControlCommon](OscalControlCommon.md) ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/lmodel/oscal ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | oscal:Parameter | | native | oscal:Parameter | ## LinkML Source ### Direct
### Induced
classDiagram
class Parameter
click Parameter href "../Parameter/"
OscalCommon <|-- Parameter
click OscalCommon href "../OscalCommon/"
Parameter : _class
Parameter : constraints
Parameter --> "*" ParameterConstraint : constraints
click ParameterConstraint href "../ParameterConstraint/"
Parameter : depends_on
Parameter : guidelines
Parameter --> "*" ParameterGuideline : guidelines
click ParameterGuideline href "../ParameterGuideline/"
Parameter : id
Parameter : label
Parameter : links
Parameter --> "*" Link : links
click Link href "../Link/"
Parameter : props
Parameter --> "*" ParameterProperty : props
click ParameterProperty href "../ParameterProperty/"
Parameter : remarks
Parameter : select
Parameter --> "0..1" ParameterSelection : select
click ParameterSelection href "../ParameterSelection/"
Parameter : usage
Parameter : values
[TokenType](TokenType.md) | A unique identifier for the parameter | direct | | [_class](_class.md) | 0..1
[TokenType](TokenType.md) | A textual label that provides a characterization of the type, purpose, use or... | direct | | [depends_on](depends_on.md) | 0..1
[TokenType](TokenType.md) | (deprecated) Another parameter invoking this one | direct | | [label](label.md) | 0..1
[MarkupLineType](MarkupLineType.md) | A short, placeholder name for the parameter, which can be used as a substitut... | direct | | [usage](usage.md) | 0..1
[MarkupMultilineType](MarkupMultilineType.md) | Describes the purpose and use of a parameter | direct | | [constraints](constraints.md) | *
[ParameterConstraint](ParameterConstraint.md) | A formal or informal expression of a constraint or test | direct | | [guidelines](guidelines.md) | *
[ParameterGuideline](ParameterGuideline.md) | A prose statement that provides a recommendation for the use of a parameter | direct | | [values](values.md) | *
[String](String.md) | A parameter value or set of values | direct | | [select](select.md) | 0..1
[ParameterSelection](ParameterSelection.md) | Presenting a choice among alternatives | direct | | [remarks](remarks.md) | 0..1
[MarkupMultilineType](MarkupMultilineType.md) | Additional commentary about the containing object | [OscalCommon](OscalCommon.md) | | [props](props.md) | *
[ParameterProperty](ParameterProperty.md) | A list of properties | [HasPropsAndLinks](HasPropsAndLinks.md) | | [links](links.md) | *
[Link](Link.md) | A list of links | [HasPropsAndLinks](HasPropsAndLinks.md) | ## Usages | used by | used in | type | used | | --- | --- | --- | --- | | [Catalog](Catalog.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Group](Group.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Control](Control.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [ProfileGroup](ProfileGroup.md) | [params](params.md) | range | [Parameter](Parameter.md) | | [Addition](Addition.md) | [params](params.md) | range | [Parameter](Parameter.md) | ## Rules ### values-xor-select | Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------| | slot_conditions |```{'values': {'value_presence': 'PRESENT'}}``` |```{'select': {'value_presence': 'ABSENT'}}``` | | ### select-xor-values | Rule Applied | Preconditions | Postconditions | Elseconditions | |--------------|---------------|----------------|----------------| | slot_conditions |```{'select': {'value_presence': 'PRESENT'}}``` |```{'values': {'value_presence': 'ABSENT'}}``` | | ## In Subsets * [OscalControlCommon](OscalControlCommon.md) ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/lmodel/oscal ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | oscal:Parameter | | native | oscal:Parameter | ## LinkML Source ### Direct
name: Parameter
description: Parameters provide a mechanism for the dynamic assignment of value(s)
in a control.
in_subset:
- oscal_control_common
from_schema: https://w3id.org/lmodel/oscal
mixins:
- OscalCommon
slots:
- id
- _class
- depends-on
- label
- usage
- constraints
- guidelines
- values
- select
slot_usage:
id:
name: id
description: A unique identifier for the parameter.
required: true
_class:
name: _class
description: A textual label that provides a characterization of the type, purpose,
use or scope of the parameter.
props:
name: props
range: ParameterProperty
rules:
- preconditions:
slot_conditions:
values:
name: values
value_presence: PRESENT
postconditions:
slot_conditions:
select:
name: select
value_presence: ABSENT
description: A parameter may have prescribed values or a selection construct, but
not both (metaschema <choice> constraint).
title: values-xor-select
- preconditions:
slot_conditions:
select:
name: select
value_presence: PRESENT
postconditions:
slot_conditions:
values:
name: values
value_presence: ABSENT
title: select-xor-values
name: Parameter
description: Parameters provide a mechanism for the dynamic assignment of value(s)
in a control.
in_subset:
- oscal_control_common
from_schema: https://w3id.org/lmodel/oscal
mixins:
- OscalCommon
slot_usage:
id:
name: id
description: A unique identifier for the parameter.
required: true
_class:
name: _class
description: A textual label that provides a characterization of the type, purpose,
use or scope of the parameter.
props:
name: props
range: ParameterProperty
attributes:
id:
name: id
description: A unique identifier for the parameter.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Group
- Control
- Role
- PartyExternalId
- Part
- Parameter
- ProfileGroup
- ControlPart
- SystemId
- ThreatId
range: TokenType
required: true
_class:
name: _class
description: A textual label that provides a characterization of the type, purpose,
use or scope of the parameter.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Group
- Control
- Property
- Part
- Parameter
- ProfileGroup
- ParameterSetting
- AssessmentPart
- ControlPart
range: TokenType
depends-on:
name: depends-on
description: (deprecated) Another parameter invoking this one. This construct
has been deprecated and should not be used.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
alias: depends_on
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: TokenType
label:
name: label
description: A short, placeholder name for the parameter, which can be used as
a substitute for a value if no value is assigned.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: MarkupLineType
usage:
name: usage
description: Describes the purpose and use of a parameter.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: MarkupMultilineType
constraints:
name: constraints
description: A formal or informal expression of a constraint or test.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: ParameterConstraint
multivalued: true
inlined: true
inlined_as_list: true
guidelines:
name: guidelines
description: A prose statement that provides a recommendation for the use of a
parameter.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: ParameterGuideline
multivalued: true
inlined: true
inlined_as_list: true
values:
name: values
description: A parameter value or set of values.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
- SetParameter
range: string
multivalued: true
select:
name: select
description: Presenting a choice among alternatives.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- Parameter
- ParameterSetting
range: ParameterSelection
inlined: true
remarks:
name: remarks
description: Additional commentary about the containing object.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- OscalCommon
- Property
- Resource
- ConstraintTest
- ControlMatching
- Removal
- ImportSSP
- LocalDefinitions
- SelectObjectiveById
- AssessmentSubjectSource
- OnDateCondition
- WithinDateRange
- AtFrequency
- TaskDependency
- SetParameter
- ComponentStatus
- PortRange
- ImplementationStatus
- ObjectiveStatus
- RelatedObservation
- AssociatedRisk
- LoggedBy
- ImportProfile
- SystemCharacteristics
- SystemStatus
- AuthorizationBoundary
- Diagram
- NetworkArchitecture
- DataFlow
- SystemImplementation
- LeveragedAuthorization
- SspImplementedRequirement
- SspStatement
- ByComponent
- ProvidedControlImplementation
- ControlResponsibility
- InheritedControlImplementation
- SatisfiedControlImplementation
- ImportAssessmentPlan
- AssessmentResultsLocalDefinitions
- ImportComponentDefinition
- ImplementedRequirement
- ImplementedControlStatement
- QualifierItem
- PoamLocalDefinitions
- RelatedFinding
range: MarkupMultilineType
props:
name: props
description: A list of properties.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- HasPropsAndLinks
- Resource
- Addition
- SystemInformation
- InformationType
- ImpactLevel
- AuthorizationBoundary
- Diagram
- NetworkArchitecture
- DataFlow
- SystemImplementation
- LeveragedAuthorization
- SspImplementedRequirement
- SspStatement
- ByComponent
- Export
- ProvidedControlImplementation
- ControlResponsibility
- InheritedControlImplementation
- SatisfiedControlImplementation
range: ParameterProperty
multivalued: true
inlined: true
inlined_as_list: true
links:
name: links
description: A list of links.
from_schema: https://w3id.org/lmodel/oscal
rank: 1000
owner: Parameter
domain_of:
- HasPropsAndLinks
- Addition
- SystemInformation
- InformationType
- ImpactLevel
- AuthorizationBoundary
- Diagram
- NetworkArchitecture
- DataFlow
- SystemImplementation
- LeveragedAuthorization
- SspImplementedRequirement
- SspStatement
- ByComponent
- Export
- ProvidedControlImplementation
- ControlResponsibility
- InheritedControlImplementation
- SatisfiedControlImplementation
range: Link
multivalued: true
inlined: true
inlined_as_list: true
rules:
- preconditions:
slot_conditions:
values:
name: values
value_presence: PRESENT
postconditions:
slot_conditions:
select:
name: select
value_presence: ABSENT
description: A parameter may have prescribed values or a selection construct, but
not both (metaschema <choice> constraint).
title: values-xor-select
- preconditions:
slot_conditions:
select:
name: select
value_presence: PRESENT
postconditions:
slot_conditions:
values:
name: values
value_presence: ABSENT
title: select-xor-values