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

Package-level declarations

Types

data class SystemView(val id: String, val definitionId: String, val title: String, val kind: ViewKind, val revision: String, val config: Map<String, Any?>, val source: SystemViewSource = SystemViewSource.CONFIGURED, val version: Int? = null)

A view every user of a tenant's application reads, as GET /view-store/system-views answers it: one the service configures (SystemViewSource.CONFIGURED, read-only), or one stored as a view of the tenant (platform) under the owner (system) (SystemViewSource.STORED), global to every tenant. Its revision is a hash of its content, whatever its source; a stored one also has the aggregate version its writes expect (If-Match).

SystemViewSource

enum class SystemViewSource : Enum<SystemViewSource>

Where a SystemView comes from.

ViewAudience

enum class ViewAudience : Enum<ViewAudience>

Who a saved view is for. It follows the view's owner: SHARED_OWNER_ID is shared, SYSTEM_OWNER_ID a stored system view, any other owner personal. A system view never moves audience.

ViewEntry

data class ViewEntry(val id: String, val definitionId: String, val title: String, val kind: ViewKind, val scope: ViewAudience, val revision: String, val config: Map<String, Any?>, val version: Int? = null, val source: SystemViewSource? = null)

One view a caller reads by id, whatever its audience, as GET /view-store/views/{id} answers it: a personal view of the caller, a shared view of its tenant, or a system view (SystemView) of its tenant and application.

ViewKind

enum class ViewKind : Enum<ViewKind>

The kind of a saved view: the kind of its config, as the view engine writes it.

ViewStoreContext

object ViewStoreContext

The view store context: the view engine's saved views, view preferences and the wording a tenant sets over the datasets it reads, ported from the 9.x view store. Commands and events are named view-store.<aggregate>.<Name>, routes start with /view-store/<aggregate>.