Package gov.nist.secauto.oscal.lib.model

Class Catalog

java.lang.Object

gov.nist.secauto.oscal.lib.model.AbstractOscalInstance

gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalog

gov.nist.secauto.oscal.lib.model.Catalog

All Implemented Interfaces:

ICatalog, IControlContainer, IGroupContainer, IOscalInstance

@MetaschemaAssembly(formalName="Catalog",
                    description="A structured, [organized collection](https://pages.nist.gov/OSCAL/concepts/terminology/#catalog) of control information.",
                    name="catalog",
                    metaschema=OscalCatalogMetaschema.class,
                    rootName="catalog",
                    remarks="Catalogs may use one or more `group` objects to subdivide the control contents of a catalog.")
@AllowedValues(level=ERROR,target="metadata/prop[has-oscal-namespace(\'http://csrc.nist.gov/ns/oscal\')]/@name",values={@AllowedValue(value="resolution-tool",description="The tool used to produce a resolved profile."),@AllowedValue(value="source-profile-uuid",description="The document-level `uuid` of the source profile from which the catalog was produced by [profile resolution](https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/).")}) @AllowedValues(level=ERROR,target="metadata/link/@rel",allowOthers=true,values={@AllowedValue(value="source-profile",description="The profile from which the catalog was produced by [profile resolution](https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/)."),@AllowedValue(value="source-profile-uuid",description="The document-level `uuid` of the profile from which the catalog was produced by [profile resolution](https://pages.nist.gov/OSCAL/concepts/processing/profile-resolution/).")})
@Index(level=ERROR,target="//part",name="catalog-parts",keyFields=@KeyField(target="@id")) @Index(level=ERROR,target="//prop",name="catalog-props",keyFields=@KeyField(target="@uuid")) @Index(level=ERROR,target="//(control|group|part)",name="catalog-groups-controls-parts",keyFields=@KeyField(target="@id")) @Index(level=ERROR,target="//control",name="catalog-controls",keyFields=@KeyField(target="@id")) @Index(level=ERROR,target="//param",name="catalog-params",keyFields=@KeyField(target="@id")) @Index(level=ERROR,target="//group",name="catalog-groups",keyFields=@KeyField(target="@id"))
public class Catalog
extends AbstractCatalog

A structured, organized collection of control information.

Constructor Summary

Constructors

Constructor	Description
Catalog()

Method Summary

Modifier and Type	Method	Description
boolean	addControl(Control item)	Add a new Control item to the underlying collection.
boolean	addGroup(CatalogGroup item)	Add a new CatalogGroup item to the underlying collection.
boolean	addParam(Parameter item)	Add a new Parameter item to the underlying collection.
BackMatter	getBackMatter()
List<Control>	getControls()
List<CatalogGroup>	getGroups()
Metadata	getMetadata()
List<Parameter>	getParams()
UUID	getUuid()
boolean	removeControl(Control item)	Remove the first matching Control item from the underlying collection.
boolean	removeGroup(CatalogGroup item)	Remove the first matching CatalogGroup item from the underlying collection.
boolean	removeParam(Parameter item)	Remove the first matching Parameter item from the underlying collection.
void	setBackMatter(BackMatter value)
void	setControls(List<Control> value)
void	setGroups(List<CatalogGroup> value)
void	setMetadata(Metadata value)
void	setParams(List<Parameter> value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class gov.nist.secauto.oscal.lib.model.control.catalog.AbstractCatalog

getReferencedParameterIds

Methods inherited from class gov.nist.secauto.oscal.lib.model.AbstractOscalInstance

getResourceByUuid

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Catalog

public Catalog()

Method Detail

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getMetadata

public Metadata getMetadata()

setMetadata

public void setMetadata(Metadata value)

getParams

public List<Parameter> getParams()

setParams

public void setParams(List<Parameter> value)

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

getControls

public List<Control> getControls()

setControls

public void setControls(List<Control> value)

addControl

public boolean addControl(Control item)

Add a new Control item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeControl

public boolean removeControl(Control item)

Remove the first matching Control item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getGroups

public List<CatalogGroup> getGroups()

setGroups

public void setGroups(List<CatalogGroup> value)

addGroup

public boolean addGroup(CatalogGroup item)

Add a new CatalogGroup item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeGroup

public boolean removeGroup(CatalogGroup item)

Remove the first matching CatalogGroup item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getBackMatter

public BackMatter getBackMatter()

setBackMatter

public void setBackMatter(BackMatter value)

toString

public String toString()

Overrides:

toString in class Object