Package dev.metaschema.oscal.lib.model

Class ProfileGroup

java.lang.Object
dev.metaschema.oscal.lib.model.ProfileGroup
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Control Group", description="A group of (selected) controls or of groups of controls.", name="group", moduleClass=OscalProfileModule.class, remarks="This construct mirrors the same construct that exists in an OSCAL catalog.") public class ProfileGroup extends Object implements dev.metaschema.core.model.IBoundObject
A group of (selected) controls or of groups of controls.

  • Constructor Details

    • ProfileGroup

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

    • ProfileGroup

      public ProfileGroup(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.ProfileGroup 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

    • getId

      @Nullable public String getId()
      Get the "Group Identifier".

      Identifies the group.

      Returns:
      the id value, or null if not set

    • setId

      public void setId(@Nullable String value)
      Set the "Group Identifier".

      Identifies the group.

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

    • getClazz

      @Nullable public String getClazz()
      Get the "Group Class".

      A textual label that provides a sub-type or characterization of the group.

      Returns:
      the class value, or null if not set

    • setClazz

      public void setClazz(@Nullable String value)
      Set the "Group Class".

      A textual label that provides a sub-type or characterization of the group.

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

    • getTitle

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

      A name to be given to the group for use in display.

      Returns:
      the title value

    • setTitle

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

      A name to be given to the group for use in display.

      Parameters:
      value - the title value to set

    • getParams

      @NonNull public List<Parameter> getParams()
      Get the "Parameter".

      Parameters provide a mechanism for the dynamic assignment of value(s) in a control.

      Returns:
      the param value

    • setParams

      public void setParams(@NonNull List<Parameter> value)
      Set the "Parameter".

      Parameters provide a mechanism for the dynamic assignment of value(s) in a control.

      Parameters:
      value - the param value to set

    • addParam

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

    • removeParam

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

    • 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

    • getParts

      @NonNull public List<ControlPart> getParts()
      Get the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Returns:
      the part value

    • setParts

      public void setParts(@NonNull List<ControlPart> value)
      Set the "Part".

      An annotated, markup-based textual element of a control's or catalog group's definition, or a child of another part.

      Parameters:
      value - the part value to set

    • addPart

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

    • removePart

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

    • getGroups

      @NonNull public List<ProfileGroup> getGroups()
      Get the "Control Group".

      A group of (selected) controls or of groups of controls.

      Returns:
      the group value

    • setGroups

      public void setGroups(@NonNull List<ProfileGroup> value)
      Set the "Control Group".

      A group of (selected) controls or of groups of controls.

      Parameters:
      value - the group value to set

    • addGroup

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

    • removeGroup

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

    • getInsertControls

      @NonNull public List<InsertControls> getInsertControls()
      Get the "Insert Controls".

      Specifies which controls to use in the containing context.

      Returns:
      the insert-controls value

    • setInsertControls

      public void setInsertControls(@NonNull List<InsertControls> value)
      Set the "Insert Controls".

      Specifies which controls to use in the containing context.

      Parameters:
      value - the insert-controls value to set

    • addInsertControls

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

    • removeInsertControls

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

    • toString

      public String toString()
      Overrides:
      toString in class Object