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 AbstractCatalogGroupA 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 booleanaddControl(Control item)Add a newControlitem to the underlying collection.booleanaddGroup(CatalogGroup item)Add a newCatalogGroupitem to the underlying collection.booleanaddLink(Link item)Add a newLinkitem to the underlying collection.booleanaddParam(Parameter item)Add a newParameteritem to the underlying collection.booleanaddPart(ControlPart item)Add a newControlPartitem to the underlying collection.booleanaddProp(Property item)Add a newPropertyitem to the underlying collection.StringgetClazz()List<Control>getControls()List<CatalogGroup>getGroups()StringgetId()List<Link>getLinks()List<Parameter>getParams()List<ControlPart>getParts()List<Property>getProps()gov.nist.secauto.metaschema.model.common.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.voidsetClazz(String value)voidsetControls(List<Control> value)voidsetGroups(List<CatalogGroup> value)voidsetId(String value)voidsetLinks(List<Link> value)voidsetParams(List<Parameter> value)voidsetParts(List<ControlPart> value)voidsetProps(List<Property> value)voidsetTitle(gov.nist.secauto.metaschema.model.common.datatype.markup.MarkupLine value)StringtoString()-
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 newParameteritem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeParam
public boolean removeParam(Parameter item)
Remove the first matchingParameteritem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
addProp
public boolean addProp(Property item)
Add a newPropertyitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeProp
public boolean removeProp(Property item)
Remove the first matchingPropertyitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
addLink
public boolean addLink(Link item)
Add a newLinkitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeLink
public boolean removeLink(Link item)
Remove the first matchingLinkitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getParts
public List<ControlPart> getParts()
-
setParts
public void setParts(List<ControlPart> value)
-
addPart
public boolean addPart(ControlPart item)
Add a newControlPartitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removePart
public boolean removePart(ControlPart item)
Remove the first matchingControlPartitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getGroups
public List<CatalogGroup> getGroups()
-
setGroups
public void setGroups(List<CatalogGroup> value)
-
addGroup
public boolean addGroup(CatalogGroup item)
Add a newCatalogGroupitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeGroup
public boolean removeGroup(CatalogGroup item)
Remove the first matchingCatalogGroupitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
getControls
public List<Control> getControls()
-
setControls
public void setControls(List<Control> value)
-
addControl
public boolean addControl(Control item)
Add a newControlitem to the underlying collection.- Parameters:
item- the item to add- Returns:
true
-
removeControl
public boolean removeControl(Control item)
Remove the first matchingControlitem from the underlying collection.- Parameters:
item- the item to remove- Returns:
trueif the item was removed orfalseotherwise
-
-