package gov.nist.secauto.oscal.lib.model;
   
   import gov.nist.secauto.metaschema.binding.model.annotations.AllowedValue;
   import gov.nist.secauto.metaschema.binding.model.annotations.AllowedValues;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundAssembly;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundField;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundFieldValue;
   import gov.nist.secauto.metaschema.binding.model.annotations.BoundFlag;
   import gov.nist.secauto.metaschema.binding.model.annotations.GroupAs;
  import gov.nist.secauto.metaschema.binding.model.annotations.MetaschemaAssembly;
  import gov.nist.secauto.metaschema.binding.model.annotations.ValueConstraints;
  import gov.nist.secauto.metaschema.model.common.JsonGroupAsBehavior;
  import gov.nist.secauto.metaschema.model.common.constraint.IConstraint;
  import gov.nist.secauto.metaschema.model.common.datatype.adapter.TokenAdapter;
  import gov.nist.secauto.metaschema.model.common.datatype.adapter.UuidAdapter;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLineAdapter;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultiline;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupMultilineAdapter;
  import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
  import java.lang.Override;
  import java.lang.String;
  import java.util.LinkedList;
  import java.util.List;
  import java.util.UUID;
  import org.apache.commons.lang3.builder.MultilineRecursiveToStringStyle;
  import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
  
  /**
   * Describes either recommended or an actual plan for addressing the risk.
   */
  @MetaschemaAssembly(
      formalName = "Risk Response",
      description = "Describes either recommended or an actual plan for addressing the risk.",
      name = "response",
      metaschema = OscalAssessmentCommonMetaschema.class
  )
  @ValueConstraints(
      allowedValues = {
          @AllowedValues(level = IConstraint.Level.ERROR, target = "prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name", values = @AllowedValue(value = "type", description = "")),
          @AllowedValues(level = IConstraint.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 {
    @BoundFlag(
        formalName = "Remediation Universally Unique Identifier",
        description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this remediation elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#scope). 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](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
        useName = "uuid",
        required = true,
        typeAdapter = UuidAdapter.class
    )
    private UUID _uuid;
  
    @BoundFlag(
        formalName = "Remediation Intent",
        description = "Identifies whether this is a recommendation, such as from an assessor or tool, or an actual plan accepted by the system owner.",
        useName = "lifecycle",
        required = true,
        typeAdapter = TokenAdapter.class
    )
    @ValueConstraints(
        allowedValues = @AllowedValues(level = IConstraint.Level.ERROR, allowOthers = true, values = {@AllowedValue(value = "recommendation", description = "Recommended remediation."), @AllowedValue(value = "planned", description = "The actions intended to resolve the risk."), @AllowedValue(value = "completed", description = "This remediation activities were performed to address the risk.")})
    )
    private String _lifecycle;
  
    /**
     * "The title for this response activity."
     */
    @BoundField(
        formalName = "Response Title",
        description = "The title for this response activity.",
        useName = "title",
        minOccurs = 1
    )
    @BoundFieldValue(
        typeAdapter = MarkupLineAdapter.class
    )
    private MarkupLine _title;
  
    /**
     * "A human-readable description of this response plan."
     */
    @BoundField(
        formalName = "Response Description",
        description = "A human-readable description of this response plan.",
        useName = "description",
        minOccurs = 1
    )
    @BoundFieldValue(
        typeAdapter = MarkupMultilineAdapter.class
    )
    private MarkupMultiline _description;
  
    @BoundAssembly(
        formalName = "Property",
        description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
        useName = "prop",
        maxOccurs = -1
    )
   @GroupAs(
       name = "props",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Property> _props;
 
   @BoundAssembly(
       formalName = "Link",
       description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
       useName = "link",
       maxOccurs = -1
   )
   @GroupAs(
       name = "links",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Link> _links;
 
   @BoundAssembly(
       formalName = "Origin",
       description = "Identifies the source of the finding, such as a tool, interviewed person, or activity.",
       useName = "origin",
       maxOccurs = -1,
       remarks = "Used to identify the individual and/or tool that generated this recommended or planned response."
   )
   @GroupAs(
       name = "origins",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Origin> _origins;
 
   /**
    * "Identifies an asset required to achieve remediation."
    */
   @BoundAssembly(
       formalName = "Required Asset",
       description = "Identifies an asset required to achieve remediation.",
       useName = "required-asset",
       maxOccurs = -1
   )
   @GroupAs(
       name = "required-assets",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<RequiredAsset> _requiredAssets;
 
   @BoundAssembly(
       formalName = "Task",
       description = "Represents a scheduled event or milestone, which may be associated with a series of assessment actions.",
       useName = "task",
       maxOccurs = -1
   )
   @GroupAs(
       name = "tasks",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Task> _tasks;
 
   @BoundField(
       formalName = "Remarks",
       description = "Additional commentary about the containing object.",
       useName = "remarks"
   )
   @BoundFieldValue(
       typeAdapter = MarkupMultilineAdapter.class
   )
   private MarkupMultiline _remarks;
 
   public Response() {
   }
 
   public UUID getUuid() {
     return _uuid;
   }
 
   public void setUuid(UUID value) {
     _uuid = value;
   }
 
   public String getLifecycle() {
     return _lifecycle;
   }
 
   public void setLifecycle(String value) {
     _lifecycle = value;
   }
 
   public MarkupLine getTitle() {
     return _title;
   }
 
   public void setTitle(MarkupLine value) {
     _title = value;
   }
 
   public MarkupMultiline getDescription() {
     return _description;
   }
 
   public void setDescription(MarkupMultiline value) {
     _description = value;
   }
 
   public List<Property> getProps() {
     return _props;
   }
 
   public void setProps(List<Property> value) {
     _props = value;
   }
 
   /**
    * Add a new {@link Property} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addProp(Property item) {
     Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_props == null) {
       _props = new LinkedList<>();
     }
     return _props.add(value);
   }
 
   /**
    * Remove the first matching {@link Property} item from the underlying collection.
    * @param item the item to remove
    * @return {@code true} if the item was removed or {@code false} otherwise
    */
   public boolean removeProp(Property item) {
     Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _props == null ? false : _props.remove(value);
   }
 
   public List<Link> getLinks() {
     return _links;
   }
 
   public void setLinks(List<Link> value) {
     _links = value;
   }
 
   /**
    * Add a new {@link Link} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addLink(Link item) {
     Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_links == null) {
       _links = new LinkedList<>();
     }
     return _links.add(value);
   }
 
   /**
    * Remove the first matching {@link Link} item from the underlying collection.
    * @param item the item to remove
    * @return {@code true} if the item was removed or {@code false} otherwise
    */
   public boolean removeLink(Link item) {
     Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _links == null ? false : _links.remove(value);
   }
 
   public List<Origin> getOrigins() {
     return _origins;
   }
 
   public void setOrigins(List<Origin> value) {
     _origins = value;
   }
 
   /**
    * Add a new {@link Origin} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addOrigin(Origin item) {
     Origin value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_origins == null) {
       _origins = new LinkedList<>();
     }
     return _origins.add(value);
   }
 
   /**
    * Remove the first matching {@link Origin} item from the underlying collection.
    * @param item the item to remove
    * @return {@code true} if the item was removed or {@code false} otherwise
    */
   public boolean removeOrigin(Origin item) {
     Origin value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _origins == null ? false : _origins.remove(value);
   }
 
   public List<RequiredAsset> getRequiredAssets() {
     return _requiredAssets;
   }
 
   public void setRequiredAssets(List<RequiredAsset> value) {
     _requiredAssets = value;
   }
 
   /**
    * Add a new {@link RequiredAsset} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addRequiredAsset(RequiredAsset item) {
     RequiredAsset value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_requiredAssets == null) {
       _requiredAssets = new LinkedList<>();
     }
     return _requiredAssets.add(value);
   }
 
   /**
    * Remove the first matching {@link RequiredAsset} item from the underlying collection.
    * @param item the item to remove
    * @return {@code true} if the item was removed or {@code false} otherwise
    */
   public boolean removeRequiredAsset(RequiredAsset item) {
     RequiredAsset value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _requiredAssets == null ? false : _requiredAssets.remove(value);
   }
 
   public List<Task> getTasks() {
     return _tasks;
   }
 
   public void setTasks(List<Task> value) {
     _tasks = value;
   }
 
   /**
    * Add a new {@link Task} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addTask(Task item) {
     Task value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_tasks == null) {
       _tasks = new LinkedList<>();
     }
     return _tasks.add(value);
   }
 
   /**
    * Remove the first matching {@link Task} item from the underlying collection.
    * @param item the item to remove
    * @return {@code true} if the item was removed or {@code false} otherwise
    */
   public boolean removeTask(Task item) {
     Task value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _tasks == null ? false : _tasks.remove(value);
   }
 
   public MarkupMultiline getRemarks() {
     return _remarks;
   }
 
   public void setRemarks(MarkupMultiline value) {
     _remarks = value;
   }
 
   @Override
   public String toString() {
     return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
   }
 
   /**
    * Identifies an asset required to achieve remediation.
    */
   @MetaschemaAssembly(
       formalName = "Required Asset",
       description = "Identifies an asset required to achieve remediation.",
       name = "required-asset",
       metaschema = OscalAssessmentCommonMetaschema.class
   )
   public static class RequiredAsset {
     @BoundFlag(
         formalName = "Required Universally Unique Identifier",
         description = "A [machine-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#machine-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this required asset elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#scope). The locally defined *UUID* of the `asset` 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](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same subject across revisions of the document.",
         useName = "uuid",
         required = true,
         typeAdapter = UuidAdapter.class
     )
     private UUID _uuid;
 
     @BoundAssembly(
         formalName = "Identifies the Subject",
         description = "A [human-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#human-oriented) identifier reference to a resource. Use type to indicate whether the identified resource is a component, inventory item, location, user, or something else.",
         useName = "subject",
         maxOccurs = -1,
         remarks = "Identifies an asset associated with this requirement, such as a party, system component, or inventory-item."
     )
     @GroupAs(
         name = "subjects",
         inJson = JsonGroupAsBehavior.LIST
     )
     private List<SubjectReference> _subjects;
 
     /**
      * "The title for this required asset."
      */
     @BoundField(
         formalName = "Title for Required Asset",
         description = "The title for this required asset.",
         useName = "title"
     )
     @BoundFieldValue(
         typeAdapter = MarkupLineAdapter.class
     )
     private MarkupLine _title;
 
     /**
      * "A human-readable description of this required asset."
      */
     @BoundField(
         formalName = "Description of Required Asset",
         description = "A human-readable description of this required asset.",
         useName = "description",
         minOccurs = 1
     )
     @BoundFieldValue(
         typeAdapter = MarkupMultilineAdapter.class
     )
     private MarkupMultiline _description;
 
     @BoundAssembly(
         formalName = "Property",
         description = "An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.",
         useName = "prop",
         maxOccurs = -1
     )
     @GroupAs(
         name = "props",
         inJson = JsonGroupAsBehavior.LIST
     )
     private List<Property> _props;
 
     @BoundAssembly(
         formalName = "Link",
         description = "A reference to a local or remote resource, that has a specific relation to the containing object.",
         useName = "link",
         maxOccurs = -1
     )
     @GroupAs(
         name = "links",
         inJson = JsonGroupAsBehavior.LIST
     )
     private List<Link> _links;
 
     @BoundField(
         formalName = "Remarks",
         description = "Additional commentary about the containing object.",
         useName = "remarks"
     )
     @BoundFieldValue(
         typeAdapter = MarkupMultilineAdapter.class
     )
     private MarkupMultiline _remarks;
 
     public RequiredAsset() {
     }
 
     public UUID getUuid() {
       return _uuid;
     }
 
     public void setUuid(UUID value) {
       _uuid = value;
     }
 
     public List<SubjectReference> getSubjects() {
       return _subjects;
     }
 
     public void setSubjects(List<SubjectReference> value) {
       _subjects = value;
     }
 
     /**
      * Add a new {@link SubjectReference} item to the underlying collection.
      * @param item the item to add
      * @return {@code true}
      */
     public boolean addSubject(SubjectReference item) {
       SubjectReference value = ObjectUtils.requireNonNull(item,"item cannot be null");
       if (_subjects == null) {
         _subjects = new LinkedList<>();
       }
       return _subjects.add(value);
     }
 
     /**
      * Remove the first matching {@link SubjectReference} item from the underlying collection.
      * @param item the item to remove
      * @return {@code true} if the item was removed or {@code false} otherwise
      */
     public boolean removeSubject(SubjectReference item) {
       SubjectReference value = ObjectUtils.requireNonNull(item,"item cannot be null");
       return _subjects == null ? false : _subjects.remove(value);
     }
 
     public MarkupLine getTitle() {
       return _title;
     }
 
     public void setTitle(MarkupLine value) {
       _title = value;
     }
 
     public MarkupMultiline getDescription() {
       return _description;
     }
 
     public void setDescription(MarkupMultiline value) {
       _description = value;
     }
 
     public List<Property> getProps() {
       return _props;
     }
 
     public void setProps(List<Property> value) {
       _props = value;
     }
 
     /**
      * Add a new {@link Property} item to the underlying collection.
      * @param item the item to add
      * @return {@code true}
      */
     public boolean addProp(Property item) {
       Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
       if (_props == null) {
         _props = new LinkedList<>();
       }
       return _props.add(value);
     }
 
     /**
      * Remove the first matching {@link Property} item from the underlying collection.
      * @param item the item to remove
      * @return {@code true} if the item was removed or {@code false} otherwise
      */
     public boolean removeProp(Property item) {
       Property value = ObjectUtils.requireNonNull(item,"item cannot be null");
       return _props == null ? false : _props.remove(value);
     }
 
     public List<Link> getLinks() {
       return _links;
     }
 
     public void setLinks(List<Link> value) {
       _links = value;
     }
 
     /**
      * Add a new {@link Link} item to the underlying collection.
      * @param item the item to add
      * @return {@code true}
      */
     public boolean addLink(Link item) {
       Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
       if (_links == null) {
         _links = new LinkedList<>();
       }
       return _links.add(value);
     }
 
     /**
      * Remove the first matching {@link Link} item from the underlying collection.
      * @param item the item to remove
      * @return {@code true} if the item was removed or {@code false} otherwise
      */
     public boolean removeLink(Link item) {
       Link value = ObjectUtils.requireNonNull(item,"item cannot be null");
       return _links == null ? false : _links.remove(value);
     }
 
     public MarkupMultiline getRemarks() {
       return _remarks;
     }
 
     public void setRemarks(MarkupMultiline value) {
       _remarks = value;
     }
 
     @Override
     public String toString() {
       return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
     }
   }
 }