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:
gov.nist.secauto.metaschema.core.model.IBoundObject
,ICatalogGroup
,IControlContainer
,IGroupContainer
@MetaschemaAssembly(formalName="Control Group",
description="A group of controls, or of groups of controls.",
name="group",
moduleClass=OscalCatalogModule.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.",
valueConstraints=@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
implements gov.nist.secauto.metaschema.core.model.IBoundObject
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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
addControl
(Control item) Add a newControl
item to the underlying collection.boolean
addGroup
(CatalogGroup item) Add a newCatalogGroup
item to the underlying collection.boolean
Add a newLink
item to the underlying collection.boolean
Add a newParameter
item to the underlying collection.boolean
addPart
(ControlPart item) Add a newControlPart
item to the underlying collection.boolean
Add a newProperty
item to the underlying collection.getClazz()
getId()
getLinks()
gov.nist.secauto.metaschema.core.model.IMetaschemaData
getParts()
getProps()
gov.nist.secauto.metaschema.core.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
void
setControls
(List<Control> value) void
setGroups
(List<CatalogGroup> value) void
void
void
void
setParts
(List<ControlPart> value) void
void
setTitle
(gov.nist.secauto.metaschema.core.datatype.markup.MarkupLine value) toString()
Methods inherited from class gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalogGroup
builder, getReferencedParameterIds
-
Constructor Details
-
CatalogGroup
public CatalogGroup() -
CatalogGroup
-
-
Method Details
-
getMetaschemaData
- Specified by:
getMetaschemaData
in interfacegov.nist.secauto.metaschema.core.model.IBoundObject
-
getId
-
setId
-
getClazz
-
setClazz
-
getTitle
-
setTitle
-
getParams
- Specified by:
getParams
in interfaceIControlContainer
-
setParams
-
addParam
Add a newParameter
item to the underlying collection.- Specified by:
addParam
in interfaceIControlContainer
- Parameters:
item
- the item to add- Returns:
true
-
removeParam
Remove the first matchingParameter
item from the underlying collection.- Specified by:
removeParam
in interfaceIControlContainer
- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getProps
-
setProps
-
addProp
Add a newProperty
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeProp
Remove the first matchingProperty
item from the underlying collection.- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getLinks
-
setLinks
-
addLink
Add a newLink
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removeLink
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
- Specified by:
getParts
in interfaceICatalogGroup
-
setParts
-
addPart
Add a newControlPart
item to the underlying collection.- Parameters:
item
- the item to add- Returns:
true
-
removePart
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
- Specified by:
getGroups
in interfaceIGroupContainer
-
setGroups
-
addGroup
Add a newCatalogGroup
item to the underlying collection.- Specified by:
addGroup
in interfaceIGroupContainer
- Parameters:
item
- the item to add- Returns:
true
-
removeGroup
Remove the first matchingCatalogGroup
item from the underlying collection.- Specified by:
removeGroup
in interfaceIGroupContainer
- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
getControls
- Specified by:
getControls
in interfaceIControlContainer
-
setControls
-
addControl
Add a newControl
item to the underlying collection.- Specified by:
addControl
in interfaceIControlContainer
- Parameters:
item
- the item to add- Returns:
true
-
removeControl
Remove the first matchingControl
item from the underlying collection.- Specified by:
removeControl
in interfaceIControlContainer
- Parameters:
item
- the item to remove- Returns:
true
if the item was removed orfalse
otherwise
-
toString
-