stig-core/com.stigway.metamodels.highway/DocumentMetadata

DocumentMetadata

data class DocumentMetadata(val iso26262Id: String? = null, val retentionClass: RetentionClass? = null, val securityClass: SecurityClass? = null, val workflowStatus: WorkflowStatus = WorkflowStatus.DRAFT, val releaseStatus: ReleaseStatus = ReleaseStatus.NOT_RELEASED, val version: Semver? = null, val versionHistory: List<VersionEntry> = emptyList())

Document-level metadata attached to a top-level work-product container — a Requirements, Tests, Analysis, or Design. Nested containers (sections/chapters within a document) do not carry their own DocumentMetadata; the lifecycle information belongs to the deliverable as a whole.

Modelled after the ISO 26262 document-information header in safety work products: an ISO 26262 work-product identifier, retention class, security class, two independent lifecycle axes (workflowStatus and releaseStatus), version, and version history.

Constructors

DocumentMetadata

constructor(iso26262Id: String? = null, retentionClass: RetentionClass? = null, securityClass: SecurityClass? = null, workflowStatus: WorkflowStatus = WorkflowStatus.DRAFT, releaseStatus: ReleaseStatus = ReleaseStatus.NOT_RELEASED, version: Semver? = null, versionHistory: List<VersionEntry> = emptyList())

Properties

iso26262Id

val iso26262Id: String?

ISO 26262 work-product identifier, e.g. "4-6.5.7 Safety analyses report". Free-form to accommodate other safety standards (ISO 21448, ISO/SAE 21434, …).

releaseStatus

val releaseStatus: ReleaseStatus

retentionClass

val retentionClass: RetentionClass?

securityClass

val securityClass: SecurityClass?

version

val version: Semver?

Current document version. SemVer 2.0.0 format (MAJOR.MINOR.PATCH[-prerelease][+build]); Semver throws on invalid format at construction.

versionHistory

val versionHistory: List<VersionEntry>

Chronological history of versions. Each entry records (version, date, authors, description). Convention: most recent entry last; the latest entry's version should equal version.

workflowStatus

val workflowStatus: WorkflowStatus