Package dev.metaschema.oscal.lib.model

Class Characterization

java.lang.Object
dev.metaschema.oscal.lib.model.Characterization
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaAssembly(formalName="Characterization", description="A collection of descriptive data about the containing object from a specific origin.", name="characterization", moduleClass=OscalAssessmentCommonModule.class) public class Characterization extends Object implements dev.metaschema.core.model.IBoundObject
A collection of descriptive data about the containing object from a specific origin.

  • Constructor Details

    • Characterization

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

    • Characterization

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

    • 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

    • getOrigin

      @NonNull public Origin getOrigin()
      Get the "Origin".

      Identifies the source of the finding, such as a tool, interviewed person, or activity.

      Returns:
      the origin value

    • setOrigin

      public void setOrigin(@NonNull Origin value)
      Set the "Origin".

      Identifies the source of the finding, such as a tool, interviewed person, or activity.

      Parameters:
      value - the origin value to set

    • getFacets

      @NonNull public List<Characterization.Facet> getFacets()
      Get the "Facet".

      An individual characteristic that is part of a larger set produced by the same actor.

      Returns:
      the facet value

    • setFacets

      public void setFacets(@NonNull List<Characterization.Facet> value)
      Set the "Facet".

      An individual characteristic that is part of a larger set produced by the same actor.

      Parameters:
      value - the facet value to set

    • addFacet

      public boolean addFacet(Characterization.Facet item)
      Add a new Characterization.Facet item to the underlying collection.
      Parameters:
      item - the item to add
      Returns:
      true

    • removeFacet

      public boolean removeFacet(Characterization.Facet item)
      Remove the first matching Characterization.Facet 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