Package dev.metaschema.oscal.lib.model

Class PoamItem

java.lang.Object
dev.metaschema.oscal.lib.model.PoamItem
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="POA&M Item", description="Describes an individual POA\\&M item.", name="poam-item", moduleClass=OscalPoamModule.class, valueConstraints=@ValueConstraints(expect=@Expect(id="oscal-poam-item-uuid",level=WARNING,test="@uuid",message="It is a best practice to provide a UUID."))) public class PoamItem extends Object implements dev.metaschema.core.model.IBoundObject
Describes an individual POA&M item.

  • Constructor Details

    • PoamItem

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

    • PoamItem

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

      @Nullable public UUID getUuid()
      Get the "POA&M Item Universally Unique Identifier".

      A machine-oriented, globally unique identifier with instance scope that can be used to reference this POA&M item entry in this 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, or null if not set

    • setUuid

      public void setUuid(@Nullable UUID value)
      Set the "POA&M Item Universally Unique Identifier".

      A machine-oriented, globally unique identifier with instance scope that can be used to reference this POA&M item entry in this 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, or null to clear

    • getTitle

      @NonNull public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "POA&M Item Title".

      The title or name for this POA&M item .

      Returns:
      the title value

    • setTitle

      public void setTitle(@NonNull dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "POA&M Item Title".

      The title or name for this POA&M item .

      Parameters:
      value - the title value to set

    • getDescription

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "POA&M Item Description".

      A human-readable description of POA&M item.

      Returns:
      the description value

    • setDescription

      public void setDescription(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "POA&M Item Description".

      A human-readable description of POA&M item.

      Parameters:
      value - the description value to set

    • 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

    • getOrigins

      @NonNull public List<PoamItem.Origin> getOrigins()
      Get the "Origin".

      Identifies the source of the finding, such as a tool or person.

      Returns:
      the origin value

    • setOrigins

      public void setOrigins(@NonNull List<PoamItem.Origin> value)
      Set the "Origin".

      Identifies the source of the finding, such as a tool or person.

      Parameters:
      value - the origin value to set

    • addOrigin

      public boolean addOrigin(PoamItem.Origin item)
      Add a new PoamItem.Origin item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeOrigin

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

    • getRelatedFindings

      @NonNull public List<PoamItem.RelatedFinding> getRelatedFindings()
      Get the "Related Finding".

      Relates the poam-item to referenced finding(s).

      Returns:
      the related-finding value

    • setRelatedFindings

      public void setRelatedFindings(@NonNull List<PoamItem.RelatedFinding> value)
      Set the "Related Finding".

      Relates the poam-item to referenced finding(s).

      Parameters:
      value - the related-finding value to set

    • addRelatedFinding

      public boolean addRelatedFinding(PoamItem.RelatedFinding item)
      Add a new PoamItem.RelatedFinding item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeRelatedFinding

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

    • getRelatedObservations

      @NonNull public List<PoamItem.RelatedObservation> getRelatedObservations()
      Get the "Related Observation".

      Relates the poam-item to a set of referenced observations that were used to determine the finding.

      Returns:
      the related-observation value

    • setRelatedObservations

      public void setRelatedObservations(@NonNull List<PoamItem.RelatedObservation> value)
      Set the "Related Observation".

      Relates the poam-item to a set of referenced observations that were used to determine the finding.

      Parameters:
      value - the related-observation value to set

    • addRelatedObservation

      public boolean addRelatedObservation(PoamItem.RelatedObservation item)
      Add a new PoamItem.RelatedObservation item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeRelatedObservation

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

    • getRelatedRisks

      @NonNull public List<PoamItem.AssociatedRisk> getRelatedRisks()
      Get the "Associated Risk".

      Relates the finding to a set of referenced risks that were used to determine the finding.

      Returns:
      the associated-risk value

    • setRelatedRisks

      public void setRelatedRisks(@NonNull List<PoamItem.AssociatedRisk> value)
      Set the "Associated Risk".

      Relates the finding to a set of referenced risks that were used to determine the finding.

      Parameters:
      value - the associated-risk value to set

    • addAssociatedRisk

      public boolean addAssociatedRisk(PoamItem.AssociatedRisk item)
      Add a new PoamItem.AssociatedRisk item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeAssociatedRisk

      public boolean removeAssociatedRisk(PoamItem.AssociatedRisk item)
      Remove the first matching PoamItem.AssociatedRisk 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