Package dev.metaschema.oscal.lib.model

Class SystemId

java.lang.Object
dev.metaschema.oscal.lib.model.SystemId
All Implemented Interfaces:
dev.metaschema.core.model.IBoundObject
@MetaschemaField(formalName="System Identification", description="A [human-oriented](https://pages.nist.gov/OSCAL/concepts/identifier-use/#human-oriented), [globally unique](https://pages.nist.gov/OSCAL/concepts/identifier-use/#globally-unique) identifier with [cross-instance](https://pages.nist.gov/OSCAL/concepts/identifier-use/#cross-instance) scope that can be used to reference this system identification property elsewhere in [this or other OSCAL instances](https://pages.nist.gov/OSCAL/concepts/identifier-use/#scope). When referencing an externally defined `system identification`, the `system identification` must be used in the context of the external / imported OSCAL instance (e.g., uri-reference). This string should be assigned [per-subject](https://pages.nist.gov/OSCAL/concepts/identifier-use/#consistency), which means it should be consistently used to identify the same system across revisions of the document.", name="system-id", moduleClass=OscalImplementationCommonModule.class) public class SystemId extends Object implements dev.metaschema.core.model.IBoundObject
A human-oriented, globally unique identifier with cross-instance scope that can be used to reference this system identification property elsewhere in this or other OSCAL instances. When referencing an externally defined system identification, the system identification must be used in the context of the external / imported OSCAL instance (e.g., uri-reference). This string should be assigned per-subject, which means it should be consistently used to identify the same system across revisions of the document.

  • Constructor Details

    • SystemId

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

    • SystemId

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

    • getIdentifierType

      @Nullable public URI getIdentifierType()
      Get the "Identification System Type".

      Identifies the identification system from which the provided identifier was assigned.

      Returns:
      the identifier-type value, or null if not set

    • setIdentifierType

      public void setIdentifierType(@Nullable URI value)
      Set the "Identification System Type".

      Identifies the identification system from which the provided identifier was assigned.

      Parameters:
      value - the identifier-type value to set, or null to clear

    • getId

      @Nullable public String getId()
      Get the field value.
      Returns:
      the value

    • setId

      public void setId(@Nullable String value)
      Set the field value.
      Parameters:
      value - the value to set

    • toString

      public String toString()
      Overrides:
      toString in class Object