Package dev.metaschema.oscal.lib.model

Class Risk.RiskLog.Entry

java.lang.Object
dev.metaschema.oscal.lib.model.Risk.RiskLog.Entry
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
Risk.RiskLog
@MetaschemaAssembly(formalName="Risk Log Entry", description="Identifies an individual risk response that occurred as part of managing an identified risk.", name="entry", moduleClass=OscalAssessmentCommonModule.class, valueConstraints=@AllowedValues(id="oscal-risk-prop-name-values",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values=@AllowedValue(value="type",description="The type of remediation tracking entry. Can be multi-valued.")) @AllowedValues(id="oscal-risk-prop-type-values",level=ERROR,target="prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\') and @name=\'type\']/@value",allowOthers=true,values={@AllowedValue(value="vendor-check-in",description="Contacted vendor to determine the status of a pending fix to a known vulnerability."),@AllowedValue(value="status-update",description="Information related to the current state of response to this risk."),@AllowedValue(value="milestone-complete",description="A significant step in the response plan has been achieved."),@AllowedValue(value="mitigation",description="An activity was completed that reduces the likelihood or impact of this risk."),@AllowedValue(value="remediated",description="An activity was completed that eliminates the likelihood or impact of this risk."),@AllowedValue(value="closed",description="The risk is no longer applicable to the system."),@AllowedValue(value="dr-submission",description="A deviation request was made to the authorizing official."),@AllowedValue(value="dr-updated",description="A previously submitted deviation request has been modified."),@AllowedValue(value="dr-approved",description="The authorizing official approved the deviation."),@AllowedValue(value="dr-rejected",description="The authorizing official rejected the deviation.")})) public static class Risk.RiskLog.Entry extends Object implements dev.metaschema.core.model.IBoundObject
Identifies an individual risk response that occurred as part of managing an identified risk.

  • Constructor Details

    • Entry

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

    • Entry

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

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

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

      The title for this risk log entry.

      Returns:
      the title value, or null if not set

    • setTitle

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

      The title for this risk log entry.

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

    • getDescription

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

      A human-readable description of what was done regarding the risk.

      Returns:
      the description value, or null if not set

    • setDescription

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

      A human-readable description of what was done regarding the risk.

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

    • getStart

      @NonNull public ZonedDateTime getStart()
      Get the "Start".

      Identifies the start date and time of the event.

      Returns:
      the start value

    • setStart

      public void setStart(@NonNull ZonedDateTime value)
      Set the "Start".

      Identifies the start date and time of the event.

      Parameters:
      value - the start value to set

    • getEnd

      @Nullable public ZonedDateTime getEnd()
      Get the "End".

      Identifies the end date and time of the event. If the event is a point in time, the start and end will be the same date and time.

      Returns:
      the end value, or null if not set

    • setEnd

      public void setEnd(@Nullable ZonedDateTime value)
      Set the "End".

      Identifies the end date and time of the event. If the event is a point in time, the start and end will be the same date and time.

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

    • getLoggedBy

      @NonNull public List<LoggedBy> getLoggedBy()
      Get the "Logged By".

      Used to indicate who created a log entry in what role.

      Returns:
      the logged-by value

    • setLoggedBy

      public void setLoggedBy(@NonNull List<LoggedBy> value)
      Set the "Logged By".

      Used to indicate who created a log entry in what role.

      Parameters:
      value - the logged-by value to set

    • addLoggedBy

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

    • removeLoggedBy

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

    • getStatusChange

      @Nullable public String getStatusChange()
      Get the "Risk Status".

      Describes the status of the associated risk.

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

    • setStatusChange

      public void setStatusChange(@Nullable String value)
      Set the "Risk Status".

      Describes the status of the associated risk.

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

    • getRelatedResponses

      @NonNull public List<Risk.RiskLog.Entry.RelatedResponse> getRelatedResponses()
      Get the "Risk Response Reference".

      Identifies an individual risk response that this log entry is for.

      Returns:
      the related-response value

    • setRelatedResponses

      public void setRelatedResponses(@NonNull List<Risk.RiskLog.Entry.RelatedResponse> value)
      Set the "Risk Response Reference".

      Identifies an individual risk response that this log entry is for.

      Parameters:
      value - the related-response value to set

    • addRelatedResponse

      public boolean addRelatedResponse(Risk.RiskLog.Entry.RelatedResponse item)
      Add a new Risk.RiskLog.Entry.RelatedResponse item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeRelatedResponse

      public boolean removeRelatedResponse(Risk.RiskLog.Entry.RelatedResponse item)
      Remove the first matching Risk.RiskLog.Entry.RelatedResponse 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