Package dev.metaschema.oscal.lib.model

Class QualifierItem

java.lang.Object
dev.metaschema.oscal.lib.model.QualifierItem
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Relationship Qualifier", description="Describes requirements, incompatibilities and gaps that are identified between a target and source in a mapping item.", name="qualifier-item", moduleClass=OscalMappingCommonModule.class) public class QualifierItem extends Object implements dev.metaschema.core.model.IBoundObject
Describes requirements, incompatibilities and gaps that are identified between a target and source in a mapping item.

  • Constructor Details

    • QualifierItem

      public QualifierItem()
      Constructs a new dev.metaschema.oscal.lib.model.QualifierItem instance with no metadata.

    • QualifierItem

      public QualifierItem(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.QualifierItem instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getSubject

      @NonNull public String getSubject()
      Get the "Subject".

      The focus of the qualifier.

      Returns:
      the subject value

    • setSubject

      public void setSubject(@NonNull String value)
      Set the "Subject".

      The focus of the qualifier.

      Parameters:
      value - the subject value to set

    • getPredicate

      @NonNull public String getPredicate()
      Get the "Predicate".

      The predicate describes how the qualifer applies to the subject.

      Returns:
      the predicate value

    • setPredicate

      public void setPredicate(@NonNull String value)
      Set the "Predicate".

      The predicate describes how the qualifer applies to the subject.

      Parameters:
      value - the predicate value to set

    • getCategory

      @NonNull public String getCategory()
      Get the "Category".

      The category expresses the resolvable nature of the predicate.

      Returns:
      the category value

    • setCategory

      public void setCategory(@NonNull String value)
      Set the "Category".

      The category expresses the resolvable nature of the predicate.

      Parameters:
      value - the category value to set

    • getDescription

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Description of the qualifier".

      Details that outline what requirements must be met, or cannot be met. If the qualifier identifies a gap, this should idenfity the gap, and any incompatibilities.

      Returns:
      the description value

    • setDescription

      public void setDescription(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Description of the qualifier".

      Details that outline what requirements must be met, or cannot be met. If the qualifier identifies a gap, this should idenfity the gap, and any incompatibilities.

      Parameters:
      value - the description value to set

    • getRemarks

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getRemarks()
      Get the "Remarks".

      Additional commentary about the containing object.

      Returns:
      the remarks value, or null if not set

    • setRemarks

      public void setRemarks(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Remarks".

      Additional commentary about the containing object.

      Parameters:
      value - the remarks value to set, or null to clear

    • toString

      public String toString()
      Overrides:
      toString in class Object