Package dev.metaschema.oscal.lib.model

Class Response

java.lang.Object
dev.metaschema.oscal.lib.model.Response
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Risk Response", description="Describes either recommended or an actual plan for addressing the risk.", name="response", moduleClass=OscalAssessmentCommonModule.class, valueConstraints=@AllowedValues(id="oscal-response-prop-name",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values=@AllowedValue(value="type",description="Risk Response Type")) @AllowedValues(id="oscal-response-prop-type-value",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'type\']/@value",values={@AllowedValue(value="avoid",description="The risk will be eliminated."),@AllowedValue(value="mitigate",description="The risk will be reduced."),@AllowedValue(value="transfer",description="The risk will be transferred to another organization or entity."),@AllowedValue(value="accept",description="The risk will continue to exist without further efforts to address it. (Sometimes referred to as \"Operationally required\")"),@AllowedValue(value="share",description="The risk will be partially transferred to another organization or entity."),@AllowedValue(value="contingency",description="Plans will be made to address the risk impact if the risk occurs. (This is a form of mitigation.)"),@AllowedValue(value="none",description="No response, such as when the identified risk is found to be a false positive.")})) public class Response extends Object implements dev.metaschema.core.model.IBoundObject
Describes either recommended or an actual plan for addressing the risk.

  • Constructor Details

    • Response

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

    • Response

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

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

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

    • getLifecycle

      @NonNull public String getLifecycle()
      Get the "Remediation Intent".

      Identifies whether this is a recommendation, such as from an assessor or tool, or an actual plan accepted by the system owner.

      Returns:
      the lifecycle value

    • setLifecycle

      public void setLifecycle(@NonNull String value)
      Set the "Remediation Intent".

      Identifies whether this is a recommendation, such as from an assessor or tool, or an actual plan accepted by the system owner.

      Parameters:
      value - the lifecycle value to set

    • getTitle

      @NonNull public dev.metaschema.core.datatype.markup.MarkupLine getTitle()
      Get the "Response Title".

      The title for this response activity.

      Returns:
      the title value

    • setTitle

      public void setTitle(@NonNull dev.metaschema.core.datatype.markup.MarkupLine value)
      Set the "Response Title".

      The title for this response activity.

      Parameters:
      value - the title value to set

    • getDescription

      @NonNull public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Response Description".

      A human-readable description of this response plan.

      Returns:
      the description value

    • setDescription

      public void setDescription(@NonNull dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Response Description".

      A human-readable description of this response plan.

      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<Origin> getOrigins()
      Get the "Origin".

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

      Returns:
      the origin value

    • setOrigins

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

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

      Parameters:
      value - the origin value to set

    • addOrigin

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

    • removeOrigin

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

    • getRequiredAssets

      @NonNull public List<Response.RequiredAsset> getRequiredAssets()
      Get the "Required Asset".

      Identifies an asset required to achieve remediation.

      Returns:
      the required-asset value

    • setRequiredAssets

      public void setRequiredAssets(@NonNull List<Response.RequiredAsset> value)
      Set the "Required Asset".

      Identifies an asset required to achieve remediation.

      Parameters:
      value - the required-asset value to set

    • addRequiredAsset

      public boolean addRequiredAsset(Response.RequiredAsset item)
      Add a new Response.RequiredAsset item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeRequiredAsset

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

    • getTasks

      @NonNull public List<Task> getTasks()
      Get the "Task".

      Represents a scheduled event or milestone, which may be associated with a series of assessment actions.

      Returns:
      the task value

    • setTasks

      public void setTasks(@NonNull List<Task> value)
      Set the "Task".

      Represents a scheduled event or milestone, which may be associated with a series of assessment actions.

      Parameters:
      value - the task value to set

    • addTask

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

    • removeTask

      public boolean removeTask(Task item)
      Remove the first matching Task 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