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

Class BackMatter

java.lang.Object

gov.nist.secauto.oscal.lib.model.metadata.AbstractBackMatter

gov.nist.secauto.oscal.lib.model.BackMatter

All Implemented Interfaces:

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

@MetaschemaAssembly(formalName="Back matter",
                    description="A collection of resources that may be referenced from within the OSCAL document instance.",
                    name="back-matter",
                    moduleClass=OscalMetadataModule.class,
                    remarks="Provides a collection of identified `resource` objects that can be referenced by a `link` with a `rel` value of \"reference\" and an `href` value that is a fragment \"#\" followed by a reference to a reference\'s `uuid`. Other specialized link \"rel\" values also use this pattern when indicated in that context of use.",
                    modelConstraints=@AssemblyConstraints(index=@Index(level=ERROR,target="resource",name="index-back-matter-resource",keyFields=@KeyField(target="@uuid"))))
public class BackMatter
extends AbstractBackMatter
implements gov.nist.secauto.metaschema.core.model.IBoundObject

A collection of resources that may be referenced from within the OSCAL document instance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackMatter.Resource	A resource associated with content in the containing document instance.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	addResource(BackMatter.Resource item)	Add a new BackMatter.Resource item to the underlying collection.
gov.nist.secauto.metaschema.core.model.IMetaschemaData	getMetaschemaData()
List<BackMatter.Resource>	getResources()
boolean	removeResource(BackMatter.Resource item)	Remove the first matching BackMatter.Resource item from the underlying collection.
void	setResources(List<BackMatter.Resource> value)
String	toString()

Methods inherited from class gov.nist.secauto.oscal.lib.model.metadata.AbstractBackMatter

getResourceByUuid

Methods inherited from class java.lang.Object

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

Constructor Details

BackMatter

public BackMatter()

BackMatter

public BackMatter(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

getResources

public List<BackMatter.Resource> getResources()

Specified by:

getResources in interface IBackMatter

setResources

public void setResources(List<BackMatter.Resource> value)

addResource

public boolean addResource(BackMatter.Resource item)

Add a new BackMatter.Resource item to the underlying collection.

Parameters:

item - the item to add

Returns:

true

removeResource

public boolean removeResource(BackMatter.Resource item)

Remove the first matching BackMatter.Resource item from the underlying collection.

Parameters:

item - the item to remove

Returns:

true if the item was removed or false otherwise

toString

public String toString()

Overrides:

toString in class Object