Package dev.metaschema.oscal.lib.model

Class AssessmentSubject

java.lang.Object
dev.metaschema.oscal.lib.model.AssessmentSubject
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Subject of Assessment", description="Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.", name="assessment-subject", moduleClass=OscalAssessmentCommonModule.class, remarks="Processing of an include/exclude pair starts with processing the include, then removing matching entries in the exclude.") public class AssessmentSubject extends Object implements dev.metaschema.core.model.IBoundObject
Identifies system elements being assessed, such as components, inventory items, and locations. In the assessment plan, this identifies a planned assessment subject. In the assessment results this is an actual assessment subject, and reflects any changes from the plan. exactly what will be the focus of this assessment. Any subjects not identified in this way are out-of-scope.

  • Constructor Details

    • AssessmentSubject

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

    • AssessmentSubject

      public AssessmentSubject(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.AssessmentSubject 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

    • getType

      @NonNull public String getType()
      Get the "Subject Type".

      Indicates the type of assessment subject, such as a component, inventory, item, location, or party represented by this selection statement.

      Returns:
      the type value

    • setType

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

      Indicates the type of assessment subject, such as a component, inventory, item, location, or party represented by this selection statement.

      Parameters:
      value - the type value to set

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Include Subjects Description".

      A human-readable description of the collection of subjects being included in this assessment.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Include Subjects Description".

      A human-readable description of the collection of subjects being included in this assessment.

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

    • getProps

      @NonNull public List<Property> getProps()
      Get the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Returns:
      the prop value

    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Parameters:
      value - the prop value to set

    • addProp

      public boolean addProp(Property item)
      Add a new Property item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeProp

      public boolean removeProp(Property item)
      Remove the first matching Property item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getLinks

      @NonNull public List<Link> getLinks()
      Get the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Returns:
      the link value

    • setLinks

      public void setLinks(@NonNull List<Link> value)
      Set the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Parameters:
      value - the link value to set

    • addLink

      public boolean addLink(Link item)
      Add a new Link item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeLink

      public boolean removeLink(Link item)
      Remove the first matching Link item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getIncludeAll

      @Nullable public IncludeAll getIncludeAll()
      Get the "Include All".

      Include all controls from the imported catalog or profile resources.

      Returns:
      the include-all value, or null if not set

    • setIncludeAll

      public void setIncludeAll(@Nullable IncludeAll value)
      Set the "Include All".

      Include all controls from the imported catalog or profile resources.

      Parameters:
      value - the include-all value to set, or null to clear

    • getIncludeSubjects

      @NonNull public List<SelectSubjectById> getIncludeSubjects()
      Get the "Select Assessment Subject".

      Identifies a set of assessment subjects to include/exclude by UUID.

      Returns:
      the include-subject value

    • setIncludeSubjects

      public void setIncludeSubjects(@NonNull List<SelectSubjectById> value)
      Set the "Select Assessment Subject".

      Identifies a set of assessment subjects to include/exclude by UUID.

      Parameters:
      value - the include-subject value to set

    • addIncludeSubject

      public boolean addIncludeSubject(SelectSubjectById item)
      Add a new SelectSubjectById item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeIncludeSubject

      public boolean removeIncludeSubject(SelectSubjectById item)
      Remove the first matching SelectSubjectById item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • getExcludeSubjects

      @NonNull public List<SelectSubjectById> getExcludeSubjects()
      Get the "Select Assessment Subject".

      Identifies a set of assessment subjects to include/exclude by UUID.

      Returns:
      the exclude-subject value

    • setExcludeSubjects

      public void setExcludeSubjects(@NonNull List<SelectSubjectById> value)
      Set the "Select Assessment Subject".

      Identifies a set of assessment subjects to include/exclude by UUID.

      Parameters:
      value - the exclude-subject value to set

    • addExcludeSubject

      public boolean addExcludeSubject(SelectSubjectById item)
      Add a new SelectSubjectById item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeExcludeSubject

      public boolean removeExcludeSubject(SelectSubjectById item)
      Remove the first matching SelectSubjectById item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise

    • 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