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.AssemblyConstraints;
   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.HasCardinality;
  import gov.nist.secauto.metaschema.binding.model.annotations.IsUnique;
  import gov.nist.secauto.metaschema.binding.model.annotations.KeyField;
  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.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;
  
  /**
   * Identifies an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.
   */
  @MetaschemaAssembly(
      formalName = "Activity",
      description = "Identifies an assessment or related process that can be performed. In the assessment plan, this is an intended activity which may be associated with an assessment task. In the assessment results, this an activity that was actually performed as part of an assessment.",
      name = "activity",
      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 = "method", description = "The assessment method to use. This typically appears on parts with the name \"assessment\".")),
          @AllowedValues(level = IConstraint.Level.ERROR, target = "prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='method']/@value", values = {@AllowedValue(value = "INTERVIEW", description = "The process of holding discussions with individuals or groups of individuals within an organization to once again, facilitate assessor understanding, achieve clarification, or obtain evidence."), @AllowedValue(value = "EXAMINE", description = "The process of reviewing, inspecting, observing, studying, or analyzing one or more assessment objects (i.e., specifications, mechanisms, or activities)."), @AllowedValue(value = "TEST", description = "The process of exercising one or more assessment objects (i.e., activities or mechanisms) under specified conditions to compare actual with expected behavior.")})
      }
  )
  @AssemblyConstraints(
      isUnique = @IsUnique(id = "unique-activity-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once."),
      hasCardinality = @HasCardinality(level = IConstraint.Level.ERROR, target = "prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal') and @name='method']", minOccurs = 1)
  )
  public class Activity {
    @BoundFlag(
        formalName = "Assessment Activity 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 assessment activity elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#scope). The locally defined *UUID* of the `activity` 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;
  
    /**
     * "The title for this included activity."
     */
    @BoundField(
        formalName = "Included Activity Title",
        description = "The title for this included activity.",
        useName = "title"
    )
    @BoundFieldValue(
        typeAdapter = MarkupLineAdapter.class
    )
    private MarkupLine _title;
  
    /**
     * "A human-readable description of this included activity."
     */
    @BoundField(
        formalName = "Included Activity Description",
        description = "A human-readable description of this included activity.",
        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;
 
   /**
    * "Identifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure."
    */
   @BoundAssembly(
       formalName = "Step",
       description = "Identifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure.",
       useName = "step",
       maxOccurs = -1
   )
   @GroupAs(
       name = "steps",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Step> _steps;
 
   @BoundAssembly(
       formalName = "Reviewed Controls and Control Objectives",
       description = "Identifies the controls being assessed and their control objectives.",
       useName = "related-controls",
       remarks = "This can be optionally used to define the set of controls and control objectives that are assessed or remediated by this activity."
   )
   private ReviewedControls _relatedControls;
 
   @BoundAssembly(
       formalName = "Responsible Role",
       description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
       useName = "responsible-role",
       maxOccurs = -1,
       remarks = "Since `responsible-role` associates multiple `party-uuid` entries with a single `role-id`, each role-id must be referenced only once."
   )
   @GroupAs(
       name = "responsible-roles",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<ResponsibleRole> _responsibleRoles;
 
   @BoundField(
       formalName = "Remarks",
       description = "Additional commentary about the containing object.",
       useName = "remarks"
   )
   @BoundFieldValue(
       typeAdapter = MarkupMultilineAdapter.class
   )
   private MarkupMultiline _remarks;
 
   public Activity() {
   }
 
   public UUID getUuid() {
     return _uuid;
   }
 
   public void setUuid(UUID value) {
     _uuid = 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<Step> getSteps() {
     return _steps;
   }
 
   public void setSteps(List<Step> value) {
     _steps = value;
   }
 
   /**
    * Add a new {@link Step} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addStep(Step item) {
     Step value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_steps == null) {
       _steps = new LinkedList<>();
     }
     return _steps.add(value);
   }
 
   /**
    * Remove the first matching {@link Step} 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 removeStep(Step item) {
     Step value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _steps == null ? false : _steps.remove(value);
   }
 
   public ReviewedControls getRelatedControls() {
     return _relatedControls;
   }
 
   public void setRelatedControls(ReviewedControls value) {
     _relatedControls = value;
   }
 
   public List<ResponsibleRole> getResponsibleRoles() {
     return _responsibleRoles;
   }
 
   public void setResponsibleRoles(List<ResponsibleRole> value) {
     _responsibleRoles = value;
   }
 
   /**
    * Add a new {@link ResponsibleRole} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addResponsibleRole(ResponsibleRole item) {
     ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_responsibleRoles == null) {
       _responsibleRoles = new LinkedList<>();
     }
     return _responsibleRoles.add(value);
   }
 
   /**
    * Remove the first matching {@link ResponsibleRole} 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 removeResponsibleRole(ResponsibleRole item) {
     ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _responsibleRoles == null ? false : _responsibleRoles.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 individual step in a series of steps related to an activity, such as an assessment test or examination procedure.
    */
   @MetaschemaAssembly(
       formalName = "Step",
       description = "Identifies an individual step in a series of steps related to an activity, such as an assessment test or examination procedure.",
       name = "step",
       metaschema = OscalAssessmentCommonMetaschema.class
   )
   @AssemblyConstraints(
       isUnique = @IsUnique(id = "unique-step-responsible-role", level = IConstraint.Level.ERROR, target = "responsible-role", keyFields = @KeyField(target = "@role-id"), remarks = "Since multiple `party-uuid` entries can be provided, each role-id must be referenced only once.")
   )
   public static class Step {
     @BoundFlag(
         formalName = "Step 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 step elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#scope). The locally defined *UUID* of the `step` (in a series of steps) 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;
 
     /**
      * "The title for this step."
      */
     @BoundField(
         formalName = "Step Title",
         description = "The title for this step.",
         useName = "title"
     )
     @BoundFieldValue(
         typeAdapter = MarkupLineAdapter.class
     )
     private MarkupLine _title;
 
     /**
      * "A human-readable description of this step."
      */
     @BoundField(
         formalName = "Step Description",
         description = "A human-readable description of this step.",
         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 = "Reviewed Controls and Control Objectives",
         description = "Identifies the controls being assessed and their control objectives.",
         useName = "reviewed-controls",
         remarks = "This can be optionally used to define the set of controls and control objectives that are assessed by this step."
     )
     private ReviewedControls _reviewedControls;
 
     @BoundAssembly(
         formalName = "Responsible Role",
         description = "A reference to a role with responsibility for performing a function relative to the containing object, optionally associated with a set of persons and/or organizations that perform that role.",
         useName = "responsible-role",
         maxOccurs = -1,
         remarks = "Identifies the roles, and optionally the parties, associated with this step that is part of an assessment activity."
     )
     @GroupAs(
         name = "responsible-roles",
         inJson = JsonGroupAsBehavior.LIST
     )
     private List<ResponsibleRole> _responsibleRoles;
 
     @BoundField(
         formalName = "Remarks",
         description = "Additional commentary about the containing object.",
         useName = "remarks"
     )
     @BoundFieldValue(
         typeAdapter = MarkupMultilineAdapter.class
     )
     private MarkupMultiline _remarks;
 
     public Step() {
     }
 
     public UUID getUuid() {
       return _uuid;
     }
 
     public void setUuid(UUID value) {
       _uuid = 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 ReviewedControls getReviewedControls() {
       return _reviewedControls;
     }
 
     public void setReviewedControls(ReviewedControls value) {
       _reviewedControls = value;
     }
 
     public List<ResponsibleRole> getResponsibleRoles() {
       return _responsibleRoles;
     }
 
     public void setResponsibleRoles(List<ResponsibleRole> value) {
       _responsibleRoles = value;
     }
 
     /**
      * Add a new {@link ResponsibleRole} item to the underlying collection.
      * @param item the item to add
      * @return {@code true}
      */
     public boolean addResponsibleRole(ResponsibleRole item) {
       ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
       if (_responsibleRoles == null) {
         _responsibleRoles = new LinkedList<>();
       }
       return _responsibleRoles.add(value);
     }
 
     /**
      * Remove the first matching {@link ResponsibleRole} 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 removeResponsibleRole(ResponsibleRole item) {
       ResponsibleRole value = ObjectUtils.requireNonNull(item,"item cannot be null");
       return _responsibleRoles == null ? false : _responsibleRoles.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();
     }
   }
 }