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

Package-level declarations

Types

@Summary(value = "Make a shared view personal")

Makes a shared view personal to the caller, in place: sent as the owner (shared) (Wow-Scope), it moves the view to the operator who sent it. The audience changes at once, the owner right after. A view a shared dashboard shows stays shared.

CreateView

@CreateAggregate

@Summary(value = "Create a view")

data class CreateView(val definitionId: String, val title: String, val config: Map<String, Any?>)

Saves a new view under the caller's owner, which is its audience: a user's, (shared) or, under the tenant (platform), (system). The server generates its id unless the route names one, and takes its application from the request's authenticated application, the request fact app_id (the app of the request's CoSec scope). The config is the view engine's ViewConfig, whole: the server checks only its shape and size.

RenameView

@Summary(value = "Rename a view")

data class RenameView(val title: String)

Renames a view.

SaveView

@Summary(value = "Save a view's config")

data class SaveView(val config: Map<String, Any?>)

Overwrites a view's config.

ShareView

@Summary(value = "Make a view shared")

data object ShareView

Makes a personal view shared, in place: the view's audience changes at once, and its owner becomes (shared) right after (the view's audience saga transfers it). The id stays.

ViewAudienceChanged

@Summary(value = "A 9.x view moved to another audience; history only, never produced")

data class ViewAudienceChanged(val audience: ViewAudience, val toOwnerId: String)

History only: never produced, only evolved. The 9.x view's move to another audience (its ViewAudienceChanged, a 9.x owner transfer), kept so the 9.x history migrate-data imports still loads: a view moves to audience as ViewShared or ViewClaimed moves it. No command produces it (the view store's tests check it); a view shared or claimed in 10.x records ViewShared or ViewClaimed. toOwnerId is the owner 9.x moved the view to, which the import records as the stream's owner (its map's owner field).

ViewClaimed

@Summary(value = "A shared view was made personal to toOwnerId, who becomes its owner")

data class ViewClaimed(val toOwnerId: String)

ViewCreated

@Summary(value = "A view was saved")

@Revision(value = 2)

data class ViewCreated(val definitionId: String, val title: String, val kind: ViewKind, val audience: ViewAudience, val appId: String, val config: Map<String, Any?>)

Revision 2 records the kind; a 9.x record (revision 1) has none, and is read with its config's kind.

ViewRenamed

@Summary(value = "A view was renamed")

data class ViewRenamed(val title: String)

ViewSaved

@Summary(value = "A view's config was overwritten")

@Revision(value = 2)

data class ViewSaved(val kind: ViewKind, val config: Map<String, Any?>)

Revision 2 records the kind; a 9.x record (revision 1) has none, and is read with its config's kind.

ViewShared

@Summary(value = "A view was made shared; its owner becomes (shared)")

data object ViewShared