Package gov.nist.secauto.oscal.lib.model
Class CatalogGroup
- java.lang.Object
-
- gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalogGroup
-
- gov.nist.secauto.oscal.lib.model.CatalogGroup
-
- All Implemented Interfaces:
ICatalogGroup
,IControlContainer
,IGroupContainer
@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\nA `group` may have its own properties, statements, parameters, and references, which are inherited by all controls of that are a member of the group.") @AllowedValues(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=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
A group of controls, or of groups of controls.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalogGroup
AbstractCatalogGroup.Builder
-
-
Constructor Summary
Constructors Constructor Description CatalogGroup()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
addControl(Control item)
Add a newControl
item to the underlying collection.boolean
addGroup(CatalogGroup item)
Add a newCatalogGroup
item to the underlying collection.boolean
addLink(Link item)
Add a newLink
item to the underlying collection.boolean
addParam(Parameter item)
Add a newParameter
item to the underlying collection.boolean
addPart(ControlPart item)
Add a newControlPart
item to the underlying collection.boolean
addProp(Property item)
Add a newProperty
item to the underlying collection.String
getClazz()
List<Control>
getControls()
List<CatalogGroup>
getGroups()
String
getId()
List<Link>
getLinks()
List<Parameter>
getParams()
List<ControlPart>
getParts()
List<Property>
getProps()
gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine
getTitle()
boolean
removeControl(Control item)
Remove the first matchingControl
item from the underlying collection.boolean
removeGroup(CatalogGroup item)
Remove the first matchingCatalogGroup
item from the underlying collection.boolean
removeLink(Link item)
Remove the first matchingLink
item from the underlying collection.boolean
removeParam(Parameter item)
Remove the first matchingParameter
item from the underlying collection.boolean
removePart(ControlPart item)
Remove the first matchingControlPart
item from the underlying collection.boolean
removeProp(Property item)
Remove the first matchingProperty
item from the underlying collection.void
setClazz(String value)
void
setControls(List<Control> value)
void
setGroups(List<CatalogGroup> value)
void
setId(String value)
void
setLinks(List<Link> value)
void
setParams(List<Parameter> value)
void
setParts(List<ControlPart> value)
void
setProps(List<Property> value)
void
setTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)
String
toString()
-
Methods inherited from class gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalogGroup
builder, getReferencedParameterIds
-
-
-
-
Constructor Detail
-
CatalogGroup
public CatalogGroup()
-
-
Method Detail
-
getTitle
public gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine getTitle()
-
setTitle
public void setTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)
-
addParam
public boolean addParam(Parameter item)
Add a newParameter
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeParam
public boolean removeParam(Parameter item)
Remove the first matchingParameter
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
addProp
public boolean addProp(Property item)
Add a newProperty
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeProp
public boolean removeProp(Property item)
Remove the first matchingProperty
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
addLink
public boolean addLink(Link item)
Add a newLink
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeLink
public boolean removeLink(Link item)
Remove the first matchingLink
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getParts
public List<ControlPart> getParts()
-
setParts
public void setParts(List<ControlPart> value)
-
addPart
public boolean addPart(ControlPart item)
Add a newControlPart
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removePart
public boolean removePart(ControlPart item)
Remove the first matchingControlPart
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getGroups
public List<CatalogGroup> getGroups()
-
setGroups
public void setGroups(List<CatalogGroup> value)
-
addGroup
public boolean addGroup(CatalogGroup item)
Add a newCatalogGroup
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeGroup
public boolean removeGroup(CatalogGroup item)
Remove the first matchingCatalogGroup
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getControls
public List<Control> getControls()
-
setControls
public void setControls(List<Control> value)
-
addControl
public boolean addControl(Control item)
Add a newControl
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeControl
public boolean removeControl(Control item)
Remove the first matchingControl
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
-