Definitions

case class Adaptor(loc: At, id: Identifier, direction: AdaptorDirection, context: ContextRef, handlers: Seq[Handler], inlets: Seq[Inlet], outlets: Seq[Outlet], types: Seq[Type], constants: Seq[Constant], functions: Seq[Function], includes: Seq[Include[AdaptorDefinition]], authors: Seq[AuthorRef], options: Seq[AdaptorOption], terms: Seq[Term], brief: Option[LiteralString], description: Option[Description]) extends Processor[AdaptorOption, AdaptorDefinition], ContextDefinition

Definition of an Adaptor.

Definition of an Adaptor. Adaptors are defined in Contexts to convert messages from another bounded context. Adaptors translate incoming messages into corresponding messages using the ubiquitous language of the defining bounded context. There should be one Adapter for each external Context

Value parameters

brief: A brief description (one sentence) for use in documentation
context: A reference to the bounded context from which messages are adapted
description: Optional description of the adaptor.
direction: An indication of whether this is an inbound or outbound adaptor.
handlers: A set of Handlers that indicate what to do when messages occur.
id: Name of the adaptor
loc: Location in the parsing input

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait Processor[AdaptorOption, AdaptorDefinition]

trait WithTypes

trait VitalDefinition[AdaptorOption, AdaptorDefinition]

trait WithTerms

trait WithIncludes[AdaptorDefinition]

trait WithAuthors

trait WithOptions[AdaptorOption]

trait Definition

trait Container[AdaptorDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of any definition that is in the content of an adaptor

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Function

class Handler

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

Attributes

Supertypes: trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Known subtypes: class InboundAdaptor

class OutboundAdaptor

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Adaptor]

class Reference[Adaptor]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

case class Application(loc: At, id: Identifier, options: Seq[ApplicationOption], types: Seq[Type], constants: Seq[Constant], groups: Seq[Group], handlers: Seq[Handler], inlets: Seq[Inlet], outlets: Seq[Outlet], functions: Seq[Function], authors: Seq[AuthorRef], terms: Seq[Term], includes: Seq[Include[ApplicationDefinition]], brief: Option[LiteralString], description: Option[Description]) extends Processor[ApplicationOption, ApplicationDefinition], DomainDefinition

An application from which a person, robot, or other active agent (the user) will obtain information, or to which that user will provided information.

Value parameters

authors: Author definitions for the application, for attribution of application components.
brief: A brief description of the application
description: A longer description of the application.
groups: A list of group definitions needed by the application
handlers: The handlers for this application to process incoming messages
id: The unique identifier for the application
includes: Included source code
inlets: Message inlets for the application
loc: The location of the application in the source
options: The options for the application
outlets: Message outlets for the application
terms: Definitions of terms useful in comprehending the application's purpose
types: Types that are needed for the communication with the user

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait Processor[ApplicationOption, ApplicationDefinition]

trait WithTypes

trait VitalDefinition[ApplicationOption, ApplicationDefinition]

trait WithTerms

trait WithIncludes[ApplicationDefinition]

trait WithAuthors

trait WithOptions[ApplicationOption]

trait Definition

trait Container[ApplicationDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of any definition that is in the content of an Application

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Function

class Handler

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

trait UIElement

class Group

class Input

class Output

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to an Application using a path identifier

Value parameters

loc: THe location of the ApplicationRef in the source code
pathId: The path identifier that refers to the Application

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Application]

class Reference[Application]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An arbitrary interaction step.

An arbitrary interaction step. The abstract nature of the relationship is

Value parameters

brief: A brief description of the interaction step
from: A reference to the source of the interaction
loc: The location of the step
relationship: A literal spring that specifies the arbitrary relationship
to: A reference to the destination of the interaction

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait GenericInteraction

trait LeafDefinition

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A value that holds the author's information

Value parameters

email: The author's email address
loc: The location of the author information
name: The full name of the author
organization: The name of the organization the author is associated with
title: The author's title within the organization
url: A URL associated with the author

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait RootDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Author]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A Reference to a command message type

Value parameters

loc: The location of the reference
pathId: The path identifier to the event type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageRef

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait WithOptions[ConnectorOption]

trait ContextDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A definition that represents a constant value for reference in behaviors

Value parameters

brief: A brief descriptin of the constant
description: A detailed description of the constant
id: The unique identifier of the Constant
loc: The location in the source of the Constant
typeEx: The type expression goverining the range of values the constant can have
value: The value of the constant

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait ProcessorDefinition

trait SagaDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Field]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

case class Context(loc: At, id: Identifier, options: Seq[ContextOption], types: Seq[Type], constants: Seq[Constant], entities: Seq[Entity], adaptors: Seq[Adaptor], sagas: Seq[Saga], streamlets: Seq[Streamlet], functions: Seq[Function], terms: Seq[Term], includes: Seq[Include[ContextDefinition]], handlers: Seq[Handler], projectors: Seq[Projector], repositories: Seq[Repository], inlets: Seq[Inlet], outlets: Seq[Outlet], connections: Seq[Connector], replicas: Seq[Replica], authors: Seq[AuthorRef], brief: Option[LiteralString], description: Option[Description]) extends Processor[ContextOption, ContextDefinition], DomainDefinition

A bounded context definition.

A bounded context definition. Bounded contexts provide a definitional boundary on the language used to describe some aspect of a system. They imply a tightly integrated ecosystem of one or more microservices that share a common purpose. Context can be used to house entities, read side projectors, sagas, adaptations to other contexts, apis, and etc.

Value parameters

adaptors: Adaptors to messages from other contexts
brief: A brief description (one sentence) for use in documentation
description: An optional description of the context
entities: Entities defined for the scope of this context
functions: Features specified for the context
id: The name of the context
loc: The location of the bounded context definition
options: The options for the context
sagas: Sagas with all-or-none semantics across various entities
types: Types defined for the scope of this context

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait Processor[ContextOption, ContextDefinition]

trait WithTypes

trait VitalDefinition[ContextOption, ContextDefinition]

trait WithTerms

trait WithIncludes[ContextDefinition]

trait WithAuthors

trait WithOptions[ContextOption]

trait Definition

trait Container[ContextDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of any definition that is in the content of a context

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Adaptor

class Connector

class Entity

class Function

class Handler

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

class Projector

class Replica

class Repository

class Saga

class Streamlet

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to a bounded context

Value parameters

loc: The location of the reference
pathId: The path identifier for the referenced context

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Context]

class Reference[Context]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

case class Domain(loc: At, id: Identifier, options: Seq[DomainOption], authors: Seq[AuthorRef], authorDefs: Seq[Author], types: Seq[Type], constants: Seq[Constant], contexts: Seq[Context], users: Seq[User], epics: Seq[Epic], sagas: Seq[Saga], applications: Seq[Application], domains: Seq[Domain], terms: Seq[Term], includes: Seq[Include[DomainDefinition]], brief: Option[LiteralString], description: Option[Description]) extends VitalDefinition[DomainOption, DomainDefinition], RootDefinition, WithTypes, DomainDefinition

The definition of a domain.

The definition of a domain. Domains are the highest building block in RIDDL and may be nested inside each other to form a hierarchy of domains. Generally, domains follow hierarchical organization structure but other taxonomies and ontologies may be modelled with domains too.

Value parameters

applications: Application definitions for this domain
brief: A brief description (one sentence) for use in documentation
contexts: The contexts defined in the scope of the domain
description: An optional description of the domain.
domains: Nested sub-domains within this domain
epics: Story definitions for this domain
id: The name of the domain
loc: The location of the domain definition
options: Options for the domain
terms: Definition of terms pertaining to this domain that provide explanation of concepts from the domain.
types: Type definitions with a domain (nearly global) scope, with applicability to many contexts or subdomains
users: User definitions for use in epics

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait WithTypes

trait RootDefinition

trait VitalDefinition[DomainOption, DomainDefinition]

trait WithTerms

trait WithIncludes[DomainDefinition]

trait WithAuthors

trait WithOptions[DomainOption]

trait Definition

trait Container[DomainDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of any definition that is in the content of a domain

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Application

class Author

class Constant

class Context

class Domain

class Epic

class Saga

class Type

class User

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to a domain definition

Value parameters

loc: The location at which the domain definition occurs
pathId: The path identifier for the referenced domain.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Domain]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

case class Entity(loc: At, id: Identifier, options: Seq[EntityOption], states: Seq[State], types: Seq[Type], constants: Seq[Constant], handlers: Seq[Handler], functions: Seq[Function], invariants: Seq[Invariant], inlets: Seq[Inlet], outlets: Seq[Outlet], includes: Seq[Include[EntityDefinition]], authors: Seq[AuthorRef], terms: Seq[Term], brief: Option[LiteralString], description: Option[Description]) extends Processor[EntityOption, EntityDefinition], ContextDefinition

Definition of an Entity

Value parameters

brief: A brief description (one sentence) for use in documentation
description: Optional description of the entity
functions: Utility functions defined for the entity
handlers: A set of event handlers
id: The name of the entity
invariants: Invariant properties of the entity
loc: The location in the input
options: The options for the entity
states: The state values of the entity
types: Type definitions useful internally to the entity definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait Processor[EntityOption, EntityDefinition]

trait WithTypes

trait VitalDefinition[EntityOption, EntityDefinition]

trait WithTerms

trait WithIncludes[EntityDefinition]

trait WithAuthors

trait WithOptions[EntityOption]

trait Definition

trait Container[EntityDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of any definition that is in the content of an entity.

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Function

class Handler

class Invariant

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

class State

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to an entity

Value parameters

loc: The location of the entity reference
pathId: The path identifier of the referenced entity.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Entity]

class Reference[Entity]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

The definition of an Epic that bundles multiple Jacobsen Use Cases into an overall story about user interactions with the system.

The definition of an Epic that bundles multiple Jacobsen Use Cases into an overall story about user interactions with the system. This define functionality from the perspective of users (men or machines) interactions with the system that is part of their role.

Value parameters

brief: A brief description (one sentence) for use in the glossary and summaries.
cases: A list of UseCase's that define the epic
description: An more detailed description of the Epic
id: The name of the Epic
loc: The location of the Epic definition
shownBy: A list of URLs to visualizations or other materials related to the epic
userStory: The UserStory (per agile and xP) that provides the overall big picture of this Epic

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait VitalDefinition[EpicOption, EpicDefinition]

trait WithTerms

trait WithIncludes[EpicDefinition]

trait WithAuthors

trait WithOptions[EpicOption]

trait Definition

trait Container[EpicDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of definitions that are in the body of a Story definition

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class UseCase

trait VitalDefinitionDefinition

class Include[T]

class Term

A reference to a Story definintion.

Value parameters

loc: Location of the StoryRef
pathId: The path id of the referenced Story

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Epic]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A Reference to an event message type

Value parameters

loc: The location of the reference
pathId: The path identifier to the event type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageRef

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Field]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A function definition which can be part of a bounded context or an entity.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the function.
examples: The set of examples that define the behavior of the function.
id: The identifier that names the function
input: An optional type expression that names and types the fields of the input of the function
loc: The location of the function definition
output: An optional type expression that names and types the fields of the output of the function

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletDefinition

trait SagaDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait FunctionDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait WithTypes

trait VitalDefinition[FunctionOption, FunctionDefinition]

trait WithTerms

trait WithIncludes[FunctionDefinition]

trait WithAuthors

trait WithOptions[FunctionOption]

trait Definition

trait Container[FunctionDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to a function.

Value parameters

loc: The location of the function reference.
pathId: The path identifier of the referenced function.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Function]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

One abstract step in an Interaction between things.

One abstract step in an Interaction between things. The set of case classes associated with this sealed trait provide more type specificity to these three fields.

Attributes

Supertypes: trait LeafDefinition

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class ArbitraryInteraction

class PutInputInteraction

class SelfInteraction

class TakeOutputInteraction

A group of UIElement that can be treated as a whole.

A group of UIElement that can be treated as a whole. For example, a form, a button group, etc.

Value parameters

brief: A brief description of the group
description: A more detailed description of the group
elements: The list of UIElements
id: The unique identifier of the group
loc: The location of the group
types: Type definitions to define types shared by more than one UIElement

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait UIElement

trait ApplicationDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A Reference to a Group

Value parameters

loc: The At locator of the group reference
pathId: The path to the referenced group

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Group]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A named handler of messages (commands, events, queries) that bundles together a set of OnMessageClause definitions and by doing so defines the behavior of an entity.

A named handler of messages (commands, events, queries) that bundles together a set of OnMessageClause definitions and by doing so defines the behavior of an entity. Note that entities may define multiple handlers and switch between them to change how it responds to messages over time or in response to changing conditions

Value parameters

brief: A brief description (one sentence) for use in documentation
clauses: The set of OnMessageClause definitions that define how the entity responds to received messages.
description: An optional description of the handler
id: The name of the handler.
loc: The location of the handler definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProjectorDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait StateDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait Definition

trait BrieflyDescribedValue

trait DescribedValue

trait Container[HandlerDefinition]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of definitions that are part of a Handler Definition

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: trait OnClause

class OnInitClause

class OnMessageClause

class OnOtherClause

class OnTerminationClause

A reference to a Handler

Value parameters

loc: The location of the handler reference
pathId: The path identifier of the referenced handler

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Handler]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait AdaptorDirection

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A value to record an inclusion of a file while parsing.

Value parameters

contents: The Vital Definitions read from the file
loc: The location of the include statement in the source
source: A string providing the source (path or URL) of the included source

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RootDefinition

trait VitalDefinitionDefinition

trait EpicDefinition

trait SagaDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait StreamletDefinition

trait FunctionDefinition

trait EntityDefinition

trait DomainDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A streamlet that supports input of data of a particular type.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the Inlet
id: The name of the inlet
loc: The location of the Inlet definition
type_: The type of the data that is received from the inlet

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait AlwaysEmpty

trait ProcessorDefinition

trait SagaDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait LeafDefinition

trait Portlet

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an Inlet

Value parameters

loc: The location of the inlet reference
pathId: The path identifier of the referenced Inlet

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PortletRef[Inlet]

class Reference[Inlet]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A Give is a UI Element to allow the user to 'give' some data to the application.

A Give is a UI Element to allow the user to 'give' some data to the application. It is analogous to a form in HTML

Value parameters

brief: A brief description of the Give
description: a detailed description of the Give
id: Name of the give
loc: Location of the Give
putIn: a Type reference of the type given by the user
types: type definitions needed for the Give

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait UIElement

trait ApplicationDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an Input using a path identifier

Value parameters

loc: THe location of the GiveRef in the source code
pathId: The path identifier that refers to the Give

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Input]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: trait GenericInteraction

class ArbitraryInteraction

class PutInputInteraction

class SelfInteraction

class TakeOutputInteraction

class OptionalInteractions

class ParallelInteractions

class SequentialInteractions
Show all

An invariant expression that can be used in the definition of an entity.

An invariant expression that can be used in the definition of an entity. Invariants provide conditional expressions that must be true at all times in the lifecycle of an entity.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the invariant.
expression: The conditional expression that must always be true.
id: The name of the invariant
loc: The location of the invariant definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StateDefinition

trait ProjectorDefinition

trait EntityDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Companion: trait
Supertypes: class Object

trait Matchable

class Any
Self type: MessageRef.type

Base trait for the four kinds of message references

Attributes

Companion: object
Supertypes: class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class CommandRef

class EventRef

class QueryRef

class RecordRef

class ResultRef

A sealed trait for the kinds of OnClause that can occur within a Handler definition.

Attributes

Supertypes: trait HandlerDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class OnInitClause

class OnMessageClause

class OnOtherClause

class OnTerminationClause

Base trait of definitions that are part of an On Clause Definition

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Defines the actions to be taken when the component this OnClause occurs in is initialized.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the on clause.
examples: A set of examples that define the behavior when a message doesn't match
loc: THe location of the "on other" clause

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait OnClause

trait HandlerDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Defines the actions to be taken when a particular message is received by an entity.

Defines the actions to be taken when a particular message is received by an entity. OnMessageClauses are used in the definition of a Handler with one for each kind of message that handler deals with.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the on clause.
examples: A set of examples that define the behavior when the msg is received.
from: Optional message generating
loc: The location of the "on" clause
msg: A reference to the message type that is handled

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait OnClause

trait HandlerDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Defines the actions to be taken when a message does not match any of the OnMessageClauses.

Defines the actions to be taken when a message does not match any of the OnMessageClauses. OnOtherClause corresponds to the "other" case of an Handler.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the on clause.
loc: THe location of the "on other" clause
statements: A set of examples that define the behavior when a message doesn't match

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait OnClause

trait HandlerDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Defines the actions to be taken when the component this OnClause occurs in is initialized.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the on clause.
examples: A set of examples that define the behavior when a message doesn't match
loc: THe location of the "on other" clause

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait OnClause

trait HandlerDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An interaction expression that specifies that its contents are optional

Value parameters

brief: A brief description of the optional group
contents: The optional expressions
loc: The location of the optional group

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait AdaptorDirection

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A streamlet that supports output of data of a particular type.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the Outlet.
id: The name of the outlet
loc: The location of the outlet definition
type_: The type expression for the kind of data put out

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait AlwaysEmpty

trait ProcessorDefinition

trait SagaDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait LeafDefinition

trait Portlet

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an Outlet

Value parameters

loc: The location of the outlet reference
pathId: The path identifier of the referenced Outlet

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait PortletRef[Outlet]

class Reference[Outlet]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A UI Element that presents some information to the user

Value parameters

brief: A brief description of the view
description: A detailed description of the view
id: unique identifier oof the view
loc: Location of the view in the source
putOut: A result reference for the data too be presented
types: any type definitions the view needs

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait UIElement

trait ApplicationDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an View using a path identifier

Value parameters

loc: The location of the ViewRef in the source code
pathId: The path identifier that refers to the View

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Output]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An interaction expression that specifies that each contained expression should be executed in parallel

Value parameters

brief: A brief description of the parallel group
contents: The expressions to execute in parallel
loc: Location of the parallel group

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A sealed trait for Inlets and Outlets

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Inlet

class Outlet

Sealed base trait of references to Inlets or Outlets

Type parameters

T: The type of definition to which the references refers.

Attributes

Supertypes: class Reference[T]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class InletRef

class OutletRef

Definition of a Processor.

Definition of a Processor. This is a base class for all Processor definitions (things that have inlets, outlets, handlers, and take messages directly with a reference).

Attributes

Supertypes: trait WithTypes

trait VitalDefinition[OPT, DEF]

trait WithTerms

trait WithIncludes[DEF]

trait WithAuthors

trait WithOptions[OPT]

trait Definition

trait Container[DEF]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet
Show all

Base trait of definitions defined in a processor

Attributes

Supertypes: trait SagaDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Constant

class Inlet

class Outlet

class Type

Base trait of definitions that can accept a message directly via a reference

Type parameters

T: The kind of reference needed

Attributes

Supertypes: class Reference[T]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class AdaptorRef

class ApplicationRef

class ContextRef

class EntityRef

class ProjectorRef

class RepositoryRef

class StreamletRef
Show all

case class Projector(loc: At, id: Identifier, authors: Seq[AuthorRef], options: Seq[ProjectorOption], includes: Seq[Include[ProjectorDefinition]], types: Seq[Type], constants: Seq[Constant], inlets: Seq[Inlet], outlets: Seq[Outlet], handlers: Seq[Handler], functions: Seq[Function], invariants: Seq[Invariant], terms: Seq[Term], brief: Option[LiteralString], description: Option[Description]) extends Processor[ProjectorOption, ProjectorDefinition], ContextDefinition, WithTypes

Projectors get their name from Euclidean Geometry but are probably more analogous to a relational database view.

Projectors get their name from Euclidean Geometry but are probably more analogous to a relational database view. The concept is very simple in RIDDL: projectors gather data from entities and other sources, transform that data into a specific record type, and support querying that data arbitrarily.

Value parameters

authors: The authors of this definition
brief: A brief description of this Projector
description: A detailed description of this Projector
handlers: Specifies how to handle
id: The unique identifier for this Projector
loc: Location in the source of the Projector
options: Options that can be used by the translators
terms: Definitions of terms about this Projector
types: The type definitions necessary to construct the query results

Attributes

See also: https://en.wikipedia.org/wiki/View_(SQL)).

https://en.wikipedia.org/wiki/Projector_(mathematics)
Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait Processor[ProjectorOption, ProjectorDefinition]

trait WithTypes

trait VitalDefinition[ProjectorOption, ProjectorDefinition]

trait WithTerms

trait WithIncludes[ProjectorDefinition]

trait WithAuthors

trait WithOptions[ProjectorOption]

trait Definition

trait Container[ProjectorDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an context's projector definition

Value parameters

loc: The location of the state reference
pathId: The path identifier of the referenced projector definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Projector]

class Reference[Projector]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A interaction where and User provides input

Value parameters

brief: A description of this interaction step
from: The user providing the input
loc: The location of the interaction in the source
relationship: A description of the relationship in this interaction
to: The input definition that receives the input

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait GenericInteraction

trait LeafDefinition

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to a query message type

Value parameters

loc: The location of the reference
pathId: The path identifier to the query type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageRef

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to a record message type

Value parameters

loc: The location of the reference
pathId: The path identifier to the result type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageRef

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A replicated value within a context.

A replicated value within a context. Integer, Map and Set values will use CRDTs

Value parameters

loc: The location of
typeExp: The type of the replica

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A RIDDL repository is an abstraction for anything that can retain information(e.g.

A RIDDL repository is an abstraction for anything that can retain information(e.g. messages for retrieval at a later time. This might be a relational database, NoSQL database, data lake, API, or something not yet invented. There is no specific technology implied other than the retention and retrieval of information. You should think of repositories more like a message-oriented version of the Java Repository Pattern than any particular kind ofdatabase.

Value parameters

authors: The author(s) who wrote this repository specification.
brief: A brief description of this repository
description: A detailed description of this repository
handlers: The handler for specifying how messages should be handled by the repository
id: The unique identifier for this Repository
includes: Included files
loc: Location in the source of the Repository
options: Options that can be used by the translators
terms: Definitions of terms about this repository
types: The types, typically messages, that the Repository uses

Attributes

See also: https://java-design-patterns.com/patterns/repository/#explanation
Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait Processor[RepositoryOption, RepositoryDefinition]

trait WithTypes

trait VitalDefinition[RepositoryOption, RepositoryDefinition]

trait WithTerms

trait WithIncludes[RepositoryDefinition]

trait WithAuthors

trait WithOptions[RepositoryOption]

trait Definition

trait Container[RepositoryDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of definitions defined in a repository

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Function

class Handler

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to a repository definition

Value parameters

loc: The location of the state reference
pathId: The path identifier of the referenced projector definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Projector]

class Reference[Projector]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to a result message type

Value parameters

loc: The location of the reference
pathId: The path identifier to the result type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait MessageRef

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

The root of the containment hierarchy, corresponding roughly to a level about a file.

Value parameters

authors: The sequence of authors defined at root scope
domains: The sequence of domains contained by this root container
inputs: The inputs for this root scope

Attributes

Companion: object
Supertypes: trait Serializable

trait Product

trait Equals

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Companion: class
Supertypes: trait Product

trait Mirror

class Object

trait Matchable

class Any
Self type: RootContainer.type

Base trait of definitions defined at root scope

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Author

class Domain

class Include[T]

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

The definition of a Saga based on inputs, outputs, and the set of SagaSteps involved in the saga.

The definition of a Saga based on inputs, outputs, and the set of SagaSteps involved in the saga. Sagas define a computing action based on a variety of related commands that must all succeed atomically or have their effects undone.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the saga.
id: The name of the saga
input: A definition of the aggregate input values needed to invoke the saga, if any.
loc: The location of the Saga definition
options: The options of the saga
output: A definition of the aggregate output values resulting from invoking the saga, if any.
sagaSteps: The set of SagaSteps that comprise the saga.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait ContextDefinition

trait VitalDefinition[SagaOption, SagaDefinition]

trait WithTerms

trait WithIncludes[SagaDefinition]

trait WithAuthors

trait WithOptions[SagaOption]

trait Definition

trait Container[SagaDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Saga]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

The definition of one step in a saga with its undo step and example.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the saga action
doStatements: The command to be done.
id: The name of the SagaAction
loc: The location of the saga action definition
undoStatements: The command that undoes doStatements

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait SagaDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait GenericInteraction

trait LeafDefinition

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An interaction expression that specifies that each contained expression should be executed in strict sequential order

Value parameters

brief: A brief description of the sequence group
contents: The interactions to execute in sequence
description: A longer description of the sequence
id: Identifier for the interaction
loc: Location of the sequence

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Represents the state of an entity.

Represents the state of an entity. The MorphAction can cause the state definition of an entity to change.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the state.
handlers: The handler definitions that may occur when this state is active
id: The name of the state definition
invariants: Expressions of boolean logic that must always evaluate to true before and after an entity changes when this state is active.
loc: The location of the state definition
typ: A reference to a type definition that provides the range of values that the state may assume.
types: Types defined within the body of the state

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait EntityDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an entity's state definition

Value parameters

loc: The location of the state reference
pathId: The path identifier of the referenced state definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[State]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Definition of a Streamlet.

Definition of a Streamlet. A computing element for processing data from Inlets to Outlets. A processor's processing is specified by free text statements in Handlers. Streamlets come in various shapes: Source, Sink, Flow, Merge, Split, and Router depending on how many inlets and outlets they have

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the processor
handlers: Definitions of how the processor handles each event type
id: The name of the processor
inlets: The list of inlets that provide the data the processor needs
loc: The location of the Processor definition
outlets: The list of outlets that the processor produces
shape: The shape of the processor's inputs and outputs

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ContextDefinition

trait Processor[StreamletOption, StreamletDefinition]

trait WithTypes

trait VitalDefinition[StreamletOption, StreamletDefinition]

trait WithTerms

trait WithIncludes[StreamletDefinition]

trait WithAuthors

trait WithOptions[StreamletOption]

trait Definition

trait Container[StreamletDefinition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Base trait of definitions define within a Streamlet

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Function

class Handler

trait ProcessorDefinition

class Constant

class Inlet

class Outlet

class Type

trait VitalDefinitionDefinition

class Include[T]

class Term
Show all

A reference to an context's projector definition

Value parameters

loc: The location of the state reference
pathId: The path identifier of the referenced projector definition

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait ProcessorRef[Streamlet]

class Reference[Streamlet]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Known subtypes: class Flow

class Merge

class Router

class Sink

class Source

class Split

class Void
Show all

An interaction where an User receives output

Value parameters

brief: A brief description of this interaction
from: The output received
loc: The locaiton of the interaction in the source
relationship: THe name of the relationship
to: THe user that receives the output

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait GenericInteraction

trait LeafDefinition

trait Interaction

trait UseCaseDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A term definition for the glossary

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait VitalDefinitionDefinition

trait EpicDefinition

trait SagaDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait StreamletDefinition

trait FunctionDefinition

trait EntityDefinition

trait DomainDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A type definition which associates an identifier with a type expression.

Value parameters

brief: A brief description (one sentence) for use in documentation
description: An optional description of the type.
id: The name of the type being defined
loc: The location of the type definition
typ: The type expression of the type being defined

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait FunctionDefinition

trait ProcessorDefinition

trait SagaDefinition

trait StreamletDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait EntityDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait StateDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to a type definition

Value parameters

loc: The location in the source where the reference to the type is made
pathId: The path identifier of the reference type

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[Type]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Sealed trait for all UI elements that derive from it

Attributes

Supertypes: trait ApplicationDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Group

class Input

class Output

The definition of a Jacobsen Use Case RIDDL defines these epics by allowing a linkage between the user and RIDDL applications or bounded contexts.

Value parameters

brief: A brief description of this use case
contents: The interactions between users and system components that define the use case.
description: A longer description of this use case
id: The unique identifier for this use case
loc: Where in the source this use case occurs

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait EpicDefinition

trait Definition

trait Container[Interaction]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An User (Role) who is the initiator of the user story.

An User (Role) who is the initiator of the user story. Users may be persons or machines

Value parameters

brief: A brief description of the user
description: A longer description of the user and its role
id: The name (role) of the user
is_a: What kind of thing the user is
loc: The location of the user in the source

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait DomainDefinition

trait LeafDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

A reference to an User using a path identifier

Value parameters

loc: THe location of the User in the source code
pathId: The path identifier that locates the User

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

class Reference[User]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

An agile user story definition in the usual "As a {role} I want {capability} so that {benefit}" style.

Value parameters

benefit: The benefit of that utilization
capability: The capability the user wishes to utilize
loc: Location of the user story
user: The user, or instigator, of the story.

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait WithTerms

trait WithIncludes[DEF]

trait WithAuthors

trait WithOptions[OPT]

trait Definition

trait Container[DEF]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Domain

class Epic

class Function

trait Processor[OPT, DEF]

class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet

class Saga
Show all

Attributes

Supertypes: trait EpicDefinition

trait SagaDefinition

trait RepositoryDefinition

trait ProjectorDefinition

trait StreamletDefinition

trait FunctionDefinition

trait EntityDefinition

trait DomainDefinition

trait ContextDefinition

trait ApplicationDefinition

trait AdaptorDefinition

trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Include[T]

class Term

Attributes

Supertypes: trait Serializable

trait Product

trait Equals

trait StreamletShape

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: trait VitalDefinition[OPT, DEF]

class Domain

class Epic

class Function

trait Processor[OPT, DEF]

class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet

class Saga
Show all

Added to definitions that support includes

Attributes

Supertypes: trait Container[T]

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: trait VitalDefinition[OPT, DEF]

class Domain

class Epic

class Function

trait Processor[OPT, DEF]

class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet

class Saga
Show all

Added to definitions that support a list of term definitions

Attributes

Supertypes: class Object

trait Matchable

class Any
Known subtypes: trait VitalDefinition[OPT, DEF]

class Domain

class Epic

class Function

trait Processor[OPT, DEF]

class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet

class Saga
Show all

Base trait of any definition that is a container and contains types

Attributes

Supertypes: trait Definition

trait Container[Definition]

trait BrieflyDescribedValue

trait DescribedValue

trait RiddlValue

trait RiddlNode

class Object

trait Matchable

class Any
Show all
Known subtypes: class Domain

class Function

trait Processor[OPT, DEF]

class Adaptor

class Application

class Context

class Entity

class Projector

class Repository

class Streamlet
Show all

Definitions

Attributes

Members list

Type members

Classlikes

Value parameters

Attributes

Attributes

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Value parameters

Attributes

Attributes

Value parameters

Attributes

Attributes

Attributes