models/joyfill/Document

Document

interface Document : Mappable

Top-level Joyfill document model.

Aggregates files, fields, and formulas with core metadata and supports map/JSON conversion via Mappable.

Properties

createdOn

abstract val createdOn: Long

Creation timestamp (epoch millis)

deleted

abstract val deleted: Boolean

Soft-delete flag

fields

abstract val fields: MutableList<Field>

Interactive/presentational fields contained in the document

files

abstract val files: MutableList<File>

Attached files associated with this document

formulas

abstract val formulas: MutableList<FormulaDefinition>

Global formula definitions evaluated in this document

abstract var id: String

Stable document identifier

identifier

abstract var identifier: String

Human-facing identifier

name

abstract var name: String

Human-readable name

stage

abstract var stage: Stage?

Optional lifecycle stage

type

abstract val type: String

Discriminator for document kind

Functions

copy

abstract fun copy(): Document

Creates a shallow copy of this document.

get

abstract fun <R> get(key: String): R

Gets a field/property identified by key cast to R.

set

abstract fun set(key: String, value: Any?)

Sets a field/property identified by key to value.

toJsonObject

abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

toJsonString

abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

toMap

abstract fun toMap(): MutableMap<String, Any?>

Converts this instance into a mutable key-value map suitable for mutation and re-serialization.

validateSchema

fun Document.validateSchema(): SchemaError?

Validates this Document against the Joyfill JSON schema.