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.markup.MarkupLine;
  import gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLineAdapter;
  import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
  import gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalogGroup;
  import java.lang.Override;
  import java.lang.String;
  import java.util.LinkedList;
  import java.util.List;
  import org.apache.commons.lang3.builder.MultilineRecursiveToStringStyle;
  import org.apache.commons.lang3.builder.ReflectionToStringBuilder;
  
  /**
   * A group of controls, or of groups of controls.
   */
  @MetaschemaAssembly(
      formalName = "Control Group",
      description = "A group of controls, or of groups of controls.",
      name = "group",
      metaschema = OscalCatalogMetaschema.class,
      remarks = "Catalogs can use the catalog `group` construct to organize related controls into a single grouping, such as a family of controls or other logical organizational structure.\n"
              + "\n"
              + "A `group` may have its own properties, statements, parameters, and references, which are inherited by all controls of that are a member of the group."
  )
  @ValueConstraints(
      allowedValues = {
          @AllowedValues(level = IConstraint.Level.ERROR, target = "prop[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name", values = {@AllowedValue(value = "label", description = "A human-readable label for the parent context, which may be rendered in place of the actual identifier for some use cases."), @AllowedValue(value = "sort-id", description = "An alternative identifier, whose value is easily sortable among other such values in the document."), @AllowedValue(value = "alt-identifier", description = "An alternate or aliased identifier for the parent context.")}),
          @AllowedValues(level = IConstraint.Level.ERROR, target = "part[has-oscal-namespace('http://csrc.nist.gov/ns/oscal')]/@name", values = {@AllowedValue(value = "overview", description = "An introduction to a control or a group of controls."), @AllowedValue(value = "instruction", description = "Information providing directions for a control or a group of controls.")})
      }
  )
  public class CatalogGroup extends AbstractCatalogGroup {
    @BoundFlag(
        formalName = "Group Identifier",
        description = "Identifies the group for the purpose of cross-linking within the defining instance or from other instances that reference the catalog.",
        useName = "id",
        typeAdapter = TokenAdapter.class
    )
    private String _id;
  
    @BoundFlag(
        formalName = "Group Class",
        description = "A textual label that provides a sub-type or characterization of the group.",
        useName = "class",
        typeAdapter = TokenAdapter.class,
        remarks = "A `class` can be used in validation rules to express extra constraints over named items of a specific `class` value.\n"
                + "\n"
                + "A `class` can also be used in an OSCAL profile as a means to target an alteration to control content."
    )
    private String _clazz;
  
    /**
     * "A name given to the group, which may be used by a tool for display and navigation."
     */
    @BoundField(
        formalName = "Group Title",
        description = "A name given to the group, which may be used by a tool for display and navigation.",
        useName = "title",
        minOccurs = 1
    )
    @BoundFieldValue(
        typeAdapter = MarkupLineAdapter.class
    )
    private MarkupLine _title;
  
    @BoundAssembly(
        formalName = "Parameter",
        description = "Parameters provide a mechanism for the dynamic assignment of value(s) in a control.",
        useName = "param",
        maxOccurs = -1
    )
    @GroupAs(
        name = "params",
        inJson = JsonGroupAsBehavior.LIST
    )
    private List<Parameter> _params;
  
    @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 = "Part",
       description = "An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.",
       useName = "part",
       maxOccurs = -1
   )
   @GroupAs(
       name = "parts",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<ControlPart> _parts;
 
   @BoundAssembly(
       formalName = "Control Group",
       description = "A group of controls, or of groups of controls.",
       useName = "group",
       maxOccurs = -1
   )
   @GroupAs(
       name = "groups",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<CatalogGroup> _groups;
 
   @BoundAssembly(
       formalName = "Control",
       description = "A [structured object](https://pages.nist.gov/OSCAL/concepts/terminology/#control) representing a requirement or guideline, which when implemented will reduce an aspect of risk related to an information system and its information.",
       useName = "control",
       maxOccurs = -1
   )
   @GroupAs(
       name = "controls",
       inJson = JsonGroupAsBehavior.LIST
   )
   private List<Control> _controls;
 
   public CatalogGroup() {
   }
 
   public String getId() {
     return _id;
   }
 
   public void setId(String value) {
     _id = value;
   }
 
   public String getClazz() {
     return _clazz;
   }
 
   public void setClazz(String value) {
     _clazz = value;
   }
 
   public MarkupLine getTitle() {
     return _title;
   }
 
   public void setTitle(MarkupLine value) {
     _title = value;
   }
 
   public List<Parameter> getParams() {
     return _params;
   }
 
   public void setParams(List<Parameter> value) {
     _params = value;
   }
 
   /**
    * Add a new {@link Parameter} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addParam(Parameter item) {
     Parameter value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_params == null) {
       _params = new LinkedList<>();
     }
     return _params.add(value);
   }
 
   /**
    * Remove the first matching {@link Parameter} 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 removeParam(Parameter item) {
     Parameter value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _params == null ? false : _params.remove(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<ControlPart> getParts() {
     return _parts;
   }
 
   public void setParts(List<ControlPart> value) {
     _parts = value;
   }
 
   /**
    * Add a new {@link ControlPart} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addPart(ControlPart item) {
     ControlPart value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_parts == null) {
       _parts = new LinkedList<>();
     }
     return _parts.add(value);
   }
 
   /**
    * Remove the first matching {@link ControlPart} 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 removePart(ControlPart item) {
     ControlPart value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _parts == null ? false : _parts.remove(value);
   }
 
   public List<CatalogGroup> getGroups() {
     return _groups;
   }
 
   public void setGroups(List<CatalogGroup> value) {
     _groups = value;
   }
 
   /**
    * Add a new {@link CatalogGroup} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addGroup(CatalogGroup item) {
     CatalogGroup value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_groups == null) {
       _groups = new LinkedList<>();
     }
     return _groups.add(value);
   }
 
   /**
    * Remove the first matching {@link CatalogGroup} 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 removeGroup(CatalogGroup item) {
     CatalogGroup value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _groups == null ? false : _groups.remove(value);
   }
 
   public List<Control> getControls() {
     return _controls;
   }
 
   public void setControls(List<Control> value) {
     _controls = value;
   }
 
   /**
    * Add a new {@link Control} item to the underlying collection.
    * @param item the item to add
    * @return {@code true}
    */
   public boolean addControl(Control item) {
     Control value = ObjectUtils.requireNonNull(item,"item cannot be null");
     if (_controls == null) {
       _controls = new LinkedList<>();
     }
     return _controls.add(value);
   }
 
   /**
    * Remove the first matching {@link Control} 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 removeControl(Control item) {
     Control value = ObjectUtils.requireNonNull(item,"item cannot be null");
     return _controls == null ? false : _controls.remove(value);
   }
 
   @Override
   public String toString() {
     return new ReflectionToStringBuilder(this, MultilineRecursiveToStringStyle.MULTI_LINE_STYLE).toString();
   }
 }