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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddControl(Control item) Add a newControlitem to the underlying collection.booleanaddGroup(CatalogGroup item) Add a newCatalogGroupitem to the underlying collection.booleanAdd a newLinkitem to the underlying collection.booleanAdd a newParameteritem to the underlying collection.booleanaddPart(ControlPart item) Add a newControlPartitem to the underlying collection.booleanAdd a newPropertyitem to the underlying collection.getClazz()getId()getLinks()gov.nist.secauto.metaschema.core.model.IMetaschemaDatagetParts()getProps()gov.nist.secauto.metaschema.core.datatype.markup.MarkupLinegetTitle()booleanremoveControl(Control item) Remove the first matchingControlitem from the underlying collection.booleanremoveGroup(CatalogGroup item) Remove the first matchingCatalogGroupitem from the underlying collection.booleanremoveLink(Link item) Remove the first matchingLinkitem from the underlying collection.booleanremoveParam(Parameter item) Remove the first matchingParameteritem from the underlying collection.booleanremovePart(ControlPart item) Remove the first matchingControlPartitem from the underlying collection.booleanremoveProp(Property item) Remove the first matchingPropertyitem from the underlying collection.voidvoidsetControls(List<Control> value) voidsetGroups(List<CatalogGroup> value) voidvoidvoidvoidsetParts(List<ControlPart> value) voidvoidsetTitle(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:
getMetaschemaDatain interfacegov.nist.secauto.metaschema.core.model.IBoundObject
-
getId
-
setId
-
getClazz
-
setClazz
-
getTitle
-
setTitle
-
getParams
- Specified by:
getParamsin interfaceIControlContainer
-
setParams
-
addParam
Add a newParameteritem to the underlying collection.- Specified by:
addParamin interfaceIControlContainer- Parameters:
item- the item to add- Returns:
true
-
removeParam
Remove the first matchingParameteritem from the underlying collection.- Specified by:
removeParamin interfaceIControlContainer- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getProps
-
setProps
-
addProp
Add a newPropertyitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeProp
Remove the first matchingPropertyitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getLinks
-
setLinks
-
addLink
Add a newLinkitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeLink
Remove the first matchingLinkitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getParts
- Specified by:
getPartsin interfaceICatalogGroup
-
setParts
-
addPart
Add a newControlPartitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removePart
Remove the first matchingControlPartitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getGroups
- Specified by:
getGroupsin interfaceIGroupContainer
-
setGroups
-
addGroup
Add a newCatalogGroupitem to the underlying collection.- Specified by:
addGroupin interfaceIGroupContainer- Parameters:
item- the item to add- Returns:
true
-
removeGroup
Remove the first matchingCatalogGroupitem from the underlying collection.- Specified by:
removeGroupin interfaceIGroupContainer- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getControls
- Specified by:
getControlsin interfaceIControlContainer
-
setControls
-
addControl
Add a newControlitem to the underlying collection.- Specified by:
addControlin interfaceIControlContainer- Parameters:
item- the item to add- Returns:
true
-
removeControl
Remove the first matchingControlitem from the underlying collection.- Specified by:
removeControlin interfaceIControlContainer- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
toString
-