Package dev.metaschema.oscal.lib.model

Class AssessmentSubjectPlaceholder

java.lang.Object
dev.metaschema.oscal.lib.model.AssessmentSubjectPlaceholder
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Assessment Subject Placeholder", description="Used when the assessment subjects will be determined as part of one or more other assessment activities. These assessment subjects will be recorded in the assessment results in the assessment log.", name="assessment-subject-placeholder", moduleClass=OscalAssessmentCommonModule.class) public class AssessmentSubjectPlaceholder extends Object implements dev.metaschema.core.model.IBoundObject
Used when the assessment subjects will be determined as part of one or more other assessment activities. These assessment subjects will be recorded in the assessment results in the assessment log.

  • Constructor Details

    • AssessmentSubjectPlaceholder

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

    • AssessmentSubjectPlaceholder

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

    • getUuid

      @NonNull public UUID getUuid()
      Get the "Assessment Subject Placeholder Universally Unique Identifier".

      A machine-oriented, globally unique identifier for a set of assessment subjects that will be identified by a task or an activity that is part of a task. The locally defined UUID of the assessment subject placeholder can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Returns:
      the uuid value

    • setUuid

      public void setUuid(@NonNull UUID value)
      Set the "Assessment Subject Placeholder Universally Unique Identifier".

      A machine-oriented, globally unique identifier for a set of assessment subjects that will be identified by a task or an activity that is part of a task. The locally defined UUID of the assessment subject placeholder can be used to reference the data item locally or globally (e.g., in an imported OSCAL instance). This UUID should be assigned per-subject, which means it should be consistently used to identify the same subject across revisions of the document.

      Parameters:
      value - the uuid value to set

    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Assessment Subject Placeholder Description".

      A human-readable description of intent of this assessment subject placeholder.

      Returns:
      the description value, or null if not set

    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Assessment Subject Placeholder Description".

      A human-readable description of intent of this assessment subject placeholder.

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

    • getSources

      @NonNull public List<AssessmentSubjectPlaceholder.Source> getSources()
      Get the "Assessment Subject Source".

      Assessment subjects will be identified while conducting the referenced activity-instance.

      Returns:
      the source value

    • setSources

      public void setSources(@NonNull List<AssessmentSubjectPlaceholder.Source> value)
      Set the "Assessment Subject Source".

      Assessment subjects will be identified while conducting the referenced activity-instance.

      Parameters:
      value - the source value to set

    • addSource

      public boolean addSource(AssessmentSubjectPlaceholder.Source item)
      Add a new AssessmentSubjectPlaceholder.Source item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeSource

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

    • 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

    • 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