Class ByComponent.Export

java.lang.Object
dev.metaschema.oscal.lib.model.ByComponent.Export
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
Enclosing class:
ByComponent

@MetaschemaAssembly(formalName="Export", description="Identifies content intended for external consumption, such as with leveraged organizations.", name="export", moduleClass=OscalSspModule.class, valueConstraints=@ValueConstraints(indexHasKey=@IndexHasKey(id="oscal-by-component-export-provided-uuid-index",level=ERROR,target="responsibility",indexName="by-component-export-provided-uuid",keyFields=@KeyField(target="@provided-uuid"))), modelConstraints=@AssemblyConstraints(cardinality=@HasCardinality(id="oscal-by-component-export-provided-responsibility-cardinality",level=ERROR,target="provided|responsibility",minOccurs=1))) public static class ByComponent.Export extends Object implements dev.metaschema.core.model.IBoundObject
Identifies content intended for external consumption, such as with leveraged organizations.
  • Constructor Details

    • Export

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

      public Export(dev.metaschema.core.model.IMetaschemaData data)
      Constructs a new dev.metaschema.oscal.lib.model.ByComponent.Export 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
    • getDescription

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getDescription()
      Get the "Control Implementation Export Description".

      An implementation statement that describes the aspects of the control or control statement implementation that can be available to another system leveraging this system.

      Returns:
      the description value, or null if not set
    • setDescription

      public void setDescription(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Control Implementation Export Description".

      An implementation statement that describes the aspects of the control or control statement implementation that can be available to another system leveraging this system.

      Parameters:
      value - the description value to set, or null to clear
    • getProps

      @NonNull public List<Property> getProps()
      Get the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Returns:
      the prop value
    • setProps

      public void setProps(@NonNull List<Property> value)
      Set the "Property".

      An attribute, characteristic, or quality of the containing object expressed as a namespace qualified name/value pair.

      Parameters:
      value - the prop value to set
    • addProp

      public boolean addProp(Property item)
      Add a new Property item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true
    • removeProp

      public boolean removeProp(Property item)
      Remove the first matching Property item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise
    • getLinks

      @NonNull public List<Link> getLinks()
      Get the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Returns:
      the link value
    • setLinks

      public void setLinks(@NonNull List<Link> value)
      Set the "Link".

      A reference to a local or remote resource, that has a specific relation to the containing object.

      Parameters:
      value - the link value to set
    • addLink

      public boolean addLink(Link item)
      Add a new Link item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true
    • removeLink

      public boolean removeLink(Link item)
      Remove the first matching Link item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise
    • getProvided

      Get the "Provided Control Implementation".

      Describes a capability which may be inherited by a leveraging system.

      Returns:
      the provided value
    • setProvided

      public void setProvided(@NonNull List<ByComponent.Export.Provided> value)
      Set the "Provided Control Implementation".

      Describes a capability which may be inherited by a leveraging system.

      Parameters:
      value - the provided value to set
    • addProvided

      Add a new ByComponent.Export.Provided item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true
    • removeProvided

      Remove the first matching ByComponent.Export.Provided item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise
    • getResponsibilities

      Get the "Control Implementation Responsibility".

      Describes a control implementation responsibility imposed on a leveraging system.

      Returns:
      the responsibility value
    • setResponsibilities

      Set the "Control Implementation Responsibility".

      Describes a control implementation responsibility imposed on a leveraging system.

      Parameters:
      value - the responsibility value to set
    • addResponsibility

      Add a new ByComponent.Export.Responsibility item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true
    • removeResponsibility

      Remove the first matching ByComponent.Export.Responsibility item from the underlying collection.
      Parameters:
      item - the item to remove
      Returns:
      true if the item was removed or false otherwise
    • getRemarks

      @Nullable public dev.metaschema.core.datatype.markup.MarkupMultiline getRemarks()
      Get the "Remarks".

      Additional commentary about the containing object.

      Returns:
      the remarks value, or null if not set
    • setRemarks

      public void setRemarks(@Nullable dev.metaschema.core.datatype.markup.MarkupMultiline value)
      Set the "Remarks".

      Additional commentary about the containing object.

      Parameters:
      value - the remarks value to set, or null to clear
    • toString

      public String toString()
      Overrides:
      toString in class Object