lib/com.prettybyte.klerk/ProcessingData

ProcessingData

data class ProcessingData<Primary : Any, C : KlerkContext, V>(val primaryModel: ModelID<Primary>? = null, val currentModel: ModelID<out Any>? = null, val actions: List<GeneralAction> = emptyList(), val createdModels: List<ModelID<out Any>> = emptyList(), val updatedModels: List<ModelID<out Any>> = emptyList(), val transitions: List<ModelID<out Any>> = emptyList(), val deletedModels: List<ModelID<out Any>> = emptyList(), val unFinalizedTransition: Triple<String, Instant, Model<out Any>>? = null, val aggregatedModelState: Map<ModelID<out Any>, Model<out Any>> = emptyMap(), val newJobs: List<Job<C, V>> = emptyList(), val remainingBlocks: List<Block<*, *, C, V>> = emptyList(), val currentBlock: Block<*, *, C, V>? = null, val processedBlocks: List<Block<*, *, C, V>> = emptyList(), val remainingCommands: List<Command<out Any, out Any?>> = emptyList(), val currentCommand: Command<out Any, out Any?>? = null, val processedCommands: List<Command<out Any, out Any?>> = emptyList(), val log: List<String> = emptyList(), val functionsToUpdateViews: List<() -> Unit> = emptyList(), val problems: List<Problem> = emptyList(), val timeTriggers: Map<ModelID<out Any>, Instant?> = emptyMap(), val remainingTimeTrigger: Model<out Any>? = null)

TODO: make sure this documentation is correct

Note that lists are used when ordering matters and maps are used for models as it is possible that a model is updated/transitioned more than once for the same command.

Constructors

ProcessingData

constructor(primaryModel: ModelID<Primary>? = null, currentModel: ModelID<out Any>? = null, actions: List<GeneralAction> = emptyList(), createdModels: List<ModelID<out Any>> = emptyList(), updatedModels: List<ModelID<out Any>> = emptyList(), transitions: List<ModelID<out Any>> = emptyList(), deletedModels: List<ModelID<out Any>> = emptyList(), unFinalizedTransition: Triple<String, Instant, Model<out Any>>? = null, aggregatedModelState: Map<ModelID<out Any>, Model<out Any>> = emptyMap(), newJobs: List<Job<C, V>> = emptyList(), remainingBlocks: List<Block<*, *, C, V>> = emptyList(), currentBlock: Block<*, *, C, V>? = null, processedBlocks: List<Block<*, *, C, V>> = emptyList(), remainingCommands: List<Command<out Any, out Any?>> = emptyList(), currentCommand: Command<out Any, out Any?>? = null, processedCommands: List<Command<out Any, out Any?>> = emptyList(), log: List<String> = emptyList(), functionsToUpdateViews: List<() -> Unit> = emptyList(), problems: List<Problem> = emptyList(), timeTriggers: Map<ModelID<out Any>, Instant?> = emptyMap(), remainingTimeTrigger: Model<out Any>? = null)

Properties

actions

val actions: List<GeneralAction>

aggregatedModelState

val aggregatedModelState: Map<ModelID<out Any>, Model<out Any>>

the models as they are after the last block was executed

createdModels

val createdModels: List<ModelID<out Any>>

models that were created. Note that they may have been modified after creation, which means that the model in this map may NOT be the final outcome for this model. See modifiedModels instead.

currentBlock

val currentBlock: Block<*, *, C, V>? = null

currentCommand

val currentCommand: Command<out Any, out Any?>? = null

currentModel

val currentModel: ModelID<out Any>? = null

is the model that was created or manipulated by the current command. Will be the same as primary unless the current command is a sub-command.

deletedModels

val deletedModels: List<ModelID<out Any>>

functionsToUpdateViews

val functionsToUpdateViews: List<() -> Unit>

log

val log: List<String>

newJobs

val newJobs: List<Job<C, V>>

primaryModel

val primaryModel: ModelID<Primary>? = null

is the model that was created or manipulated by the primary command (i.e. the command that the user initiated).

problems

val problems: List<Problem>

processedBlocks

val processedBlocks: List<Block<*, *, C, V>>

processedCommands

val processedCommands: List<Command<out Any, out Any?>>

remainingBlocks

val remainingBlocks: List<Block<*, *, C, V>>

remainingCommands

val remainingCommands: List<Command<out Any, out Any?>>

remainingTimeTrigger

val remainingTimeTrigger: Model<out Any>? = null

timeTriggers

val timeTriggers: Map<ModelID<out Any>, Instant?>

transitions

val transitions: List<ModelID<out Any>>

models that changed state. Note that they may have been modified after the transition, which means that the model in this map may NOT be the final outcome for this model. See modifiedModels instead.

unFinalizedTransition

val unFinalizedTransition: Triple<String, Instant, Model<out Any>>? = null

updatedModels

val updatedModels: List<ModelID<out Any>>

models that were updated. Note that they may have been modified after the update, which means that the model in this map may NOT be the final outcome for this model. See modifiedModels instead.

Functions

toString

open override fun toString(): String