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

Class ComponentDefinition

java.lang.Object

gov.nist.secauto.oscal.lib.model.ComponentDefinition

All Implemented Interfaces:

gov.nist.secauto.metaschema.core.model.IBoundObject

@MetaschemaAssembly(formalName="Component Definition",
                    description="A collection of component descriptions, which may optionally be grouped by capability.",
                    name="component-definition",
                    moduleClass=OscalComponentDefinitionModule.class,
                    rootName="component-definition",
                    modelConstraints=@AssemblyConstraints(index=@Index(level=ERROR,target="component",name="index-system-component-uuid",keyFields=@KeyField(target="@uuid"),remarks="Since multiple `component` entries can be provided, each component must have a unique `uuid`."),unique=@IsUnique(id="unique-component-definition-capability",level=ERROR,target="capability",keyFields=@KeyField(target="@uuid"),remarks="A given `component` must not be referenced more than once within the same `capability`.")))
public class ComponentDefinition
extends Object
implements gov.nist.secauto.metaschema.core.model.IBoundObject

A collection of component descriptions, which may optionally be grouped by capability.

Constructor Summary

Constructors

Constructor	Description
ComponentDefinition()
ComponentDefinition(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Summary

Modifier and Type	Method	Description
boolean	addCapability(Capability item)	Add a new Capability item to the underlying collection.
boolean	addComponent(DefinedComponent item)	Add a new DefinedComponent item to the underlying collection.
boolean	addImportComponentDefinition(ImportComponentDefinition item)	Add a new ImportComponentDefinition item to the underlying collection.
BackMatter	getBackMatter()
List<Capability>	getCapabilities()
List<DefinedComponent>	getComponents()
List<ImportComponentDefinition>	getImportComponentDefinitions()
Metadata	getMetadata()
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
UUID	getUuid()
boolean	removeCapability(Capability item)	Remove the first matching Capability item from the underlying collection.
boolean	removeComponent(DefinedComponent item)	Remove the first matching DefinedComponent item from the underlying collection.
boolean	removeImportComponentDefinition(ImportComponentDefinition item)	Remove the first matching ImportComponentDefinition item from the underlying collection.
void	setBackMatter(BackMatter value)
void	setCapabilities(List<Capability> value)
void	setComponents(List<DefinedComponent> value)
void	setImportComponentDefinitions(List<ImportComponentDefinition> value)
void	setMetadata(Metadata value)
void	setUuid(UUID value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentDefinition

public ComponentDefinition()

ComponentDefinition

public ComponentDefinition(gov.nist.secauto.metaschema.core.model.IMetaschemaData data)

Method Details

getMetaschemaData

public gov.nist.secauto.metaschema.core.model.IMetaschemaData getMetaschemaData()

Specified by:

getMetaschemaData in interface gov.nist.secauto.metaschema.core.model.IBoundObject

getUuid

public UUID getUuid()

setUuid

public void setUuid(UUID value)

getMetadata

public Metadata getMetadata()

setMetadata

public void setMetadata(Metadata value)

getImportComponentDefinitions

public List<ImportComponentDefinition> getImportComponentDefinitions()

setImportComponentDefinitions

public void setImportComponentDefinitions(List<ImportComponentDefinition> value)

addImportComponentDefinition

public boolean addImportComponentDefinition(ImportComponentDefinition item)

Add a new ImportComponentDefinition item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeImportComponentDefinition

public boolean removeImportComponentDefinition(ImportComponentDefinition item)

Remove the first matching ImportComponentDefinition item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getComponents

public List<DefinedComponent> getComponents()

setComponents

public void setComponents(List<DefinedComponent> value)

addComponent

public boolean addComponent(DefinedComponent item)

Add a new DefinedComponent item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeComponent

public boolean removeComponent(DefinedComponent item)

Remove the first matching DefinedComponent item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

getCapabilities

public List<Capability> getCapabilities()

setCapabilities

public void setCapabilities(List<Capability> value)

addCapability

public boolean addCapability(Capability item)

Add a new Capability item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeCapability

public boolean removeCapability(Capability item)

Remove the first matching Capability 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