Package dev.metaschema.oscal.lib.model

Class BackMatter

java.lang.Object
dev.metaschema.oscal.lib.model.metadata.AbstractBackMatter
dev.metaschema.oscal.lib.model.BackMatter
All Implemented Interfaces:
dev.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(id="oscal-back-matter-resource-uuid-index",level=ERROR,target="resource",name="index-back-matter-resource",keyFields=@KeyField(target="@uuid")))) public class BackMatter extends AbstractBackMatter implements dev.metaschema.core.model.IBoundObject
A collection of resources that may be referenced from within the OSCAL document instance.

  • Constructor Details

    • BackMatter

      public BackMatter()
      Constructs a new dev.metaschema.oscal.lib.model.BackMatter instance with no metadata.

    • BackMatter

      public BackMatter(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.BackMatter instance with the specified metadata.
      Parameters:
      data - the metaschema data, or null if none

  • Method Details

    • getMetaschemaData

      public dev.metaschema.core.model.IMetaschemaData getMetaschemaData()
      Specified by:
      getMetaschemaData in interface dev.metaschema.core.model.IBoundObject

    • getResources

      @NonNull public List<BackMatter.Resource> getResources()
      Get the "Resource".

      A resource associated with content in the containing document instance. A resource may be directly included in the document using base64 encoding or may point to one or more equivalent internet resources.

      Specified by:
      getResources in interface IBackMatter
      Returns:
      the resource value

    • setResources

      public void setResources(@NonNull List<BackMatter.Resource> value)
      Set the "Resource".

      A resource associated with content in the containing document instance. A resource may be directly included in the document using base64 encoding or may point to one or more equivalent internet resources.

      Parameters:
      value - the resource value to set

    • 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