Package dev.metaschema.oscal.lib.model

Class FindingTarget

java.lang.Object
dev.metaschema.oscal.lib.model.FindingTarget
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Objective Status", description="Captures an assessor\'s conclusions regarding the degree to which an objective is satisfied.", name="finding-target", moduleClass=OscalAssessmentCommonModule.class) public class FindingTarget extends Object implements dev.metaschema.core.model.IBoundObject
Captures an assessor's conclusions regarding the degree to which an objective is satisfied.

  • Constructor Details

    • FindingTarget

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

    • FindingTarget

      public FindingTarget(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.FindingTarget 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 "Finding Target Type".

      Identifies the type of the target.

      Returns:
      the type value

    • setType

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

      Identifies the type of the target.

      Parameters:
      value - the type value to set

    • getTargetId

      @NonNull public String getTargetId()
      Get the "Finding Target Identifier Reference".

      A machine-oriented identifier reference for a specific target qualified by the type.

      Returns:
      the target-id value

    • setTargetId

      public void setTargetId(@NonNull String value)
      Set the "Finding Target Identifier Reference".

      A machine-oriented identifier reference for a specific target qualified by the type.

      Parameters:
      value - the target-id value to set

    • getTitle

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

      The title for this objective status.

      Returns:
      the title value, or null if not set

    • setTitle

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

      The title for this objective status.

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

    • getDescription

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

      A human-readable description of the assessor's conclusions regarding the degree to which an objective is satisfied.

      Returns:
      the description value, or null if not set

    • setDescription

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

      A human-readable description of the assessor's conclusions regarding the degree to which an objective is satisfied.

      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

    • getStatus

      @NonNull public FindingTarget.Status getStatus()
      Get the "Objective Status".

      A determination of if the objective is satisfied or not within a given system.

      Returns:
      the status value

    • setStatus

      public void setStatus(@NonNull FindingTarget.Status value)
      Set the "Objective Status".

      A determination of if the objective is satisfied or not within a given system.

      Parameters:
      value - the status value to set

    • getImplementationStatus

      @Nullable public ImplementationStatus getImplementationStatus()
      Get the "Implementation Status".

      Indicates the degree to which the a given control is implemented.

      Returns:
      the implementation-status value, or null if not set

    • setImplementationStatus

      public void setImplementationStatus(@Nullable ImplementationStatus value)
      Set the "Implementation Status".

      Indicates the degree to which the a given control is implemented.

      Parameters:
      value - the implementation-status value to set, or null to clear

    • 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