Package dev.metaschema.oscal.lib.model

Class AssessmentAssets.AssessmentPlatform

java.lang.Object
dev.metaschema.oscal.lib.model.AssessmentAssets.AssessmentPlatform
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
AssessmentAssets
@MetaschemaAssembly(formalName="Assessment Platform", description="Used to represent the toolset used to perform aspects of the assessment.", name="assessment-platform", moduleClass=OscalAssessmentCommonModule.class) public static class AssessmentAssets.AssessmentPlatform extends Object implements dev.metaschema.core.model.IBoundObject
Used to represent the toolset used to perform aspects of the assessment.

  • Constructor Details

    • AssessmentPlatform

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

    • AssessmentPlatform

      public AssessmentPlatform(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.AssessmentAssets.AssessmentPlatform 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 Platform Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this assessment platform elsewhere in this or other OSCAL instances. The locally defined UUID of the assessment platform 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 Platform Universally Unique Identifier".

      A machine-oriented, globally unique identifier with cross-instance scope that can be used to reference this assessment platform elsewhere in this or other OSCAL instances. The locally defined UUID of the assessment platform 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

    • getTitle

      @Nullable public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Assessment Platform Title".

      The title or name for the assessment platform.

      Returns:
      the title value, or null if not set

    • setTitle

      public void setTitle(@Nullable dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Assessment Platform Title".

      The title or name for the assessment platform.

      Parameters:
      value - the title 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

    • getUsesComponents

      @NonNull public List<AssessmentAssets.AssessmentPlatform.UsesComponent> getUsesComponents()
      Get the "Uses Component".

      The set of components that are used by the assessment platform.

      Returns:
      the uses-component value

    • setUsesComponents

      public void setUsesComponents(@NonNull List<AssessmentAssets.AssessmentPlatform.UsesComponent> value)
      Set the "Uses Component".

      The set of components that are used by the assessment platform.

      Parameters:
      value - the uses-component value to set

    • addUsesComponent

      public boolean addUsesComponent(AssessmentAssets.AssessmentPlatform.UsesComponent item)
      Add a new AssessmentAssets.AssessmentPlatform.UsesComponent item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeUsesComponent

      public boolean removeUsesComponent(AssessmentAssets.AssessmentPlatform.UsesComponent item)
      Remove the first matching AssessmentAssets.AssessmentPlatform.UsesComponent 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