wow-view-store-api/me.ahoo.wow.viewstore.api.wording

Package-level declarations

Types

@Summary(value = "Clear the wording of a dataset")

@CommandRoute(enabled = false)

object ClearDatasetWording : DeleteAggregate

Clears a dataset's wording, which then reads as none: the wording route's DELETE dispatches it with the expected version. A command of the view store's own rather than Wow's DefaultDeleteAggregate, for the reason DeleteView gives.

DatasetWordingInput

data class DatasetWordingInput(val title: String? = null, val recordNoun: String? = null, val fields: ObjectNode? = null)

The body of the wording route's PUT: the dataset is the path's, the tenant the path's and the application the request's.

DatasetWordingSet

data class DatasetWordingSet(val dataset: String, val appId: String, val title: String?, val recordNoun: String?, val fields: ObjectNode?)

SetDatasetWording

@Summary(value = "Set the wording of a dataset")

@AllowCreate

@CommandRoute(enabled = false)

data class SetDatasetWording(val dataset: String, val title: String? = null, val recordNoun: String? = null, val fields: ObjectNode? = null)

Sets the wording a tenant's readers see over one dataset in one application: its title, its record noun and its fields' labels, order and narrowing (the view engine's DatasetOverrides). The wording's id is derived on the server from the tenant, the application and the dataset, so this command has no generated route: the view store's wording route dispatches it. The expected version 0 is "never written".