Struct ClaimWorkflow 

#[non_exhaustive]
pub struct ClaimWorkflow;

The receipt-claim workflow.

Implementations

impl ClaimWorkflow

pub const fn new() -> Self

Builds the workflow.

pub fn phase_of(state: &ClaimState) -> ClaimPhase

The phase a state projects to.

Trait Implementations

impl Clone for ClaimWorkflow

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ClaimWorkflow

impl Debug for ClaimWorkflow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ClaimWorkflow

fn default() -> Self

Returns the “default value” for a type.

impl PureWorkflow for ClaimWorkflow

fn apply( &self, state: Option<&ClaimState>, command: &ClaimCommand, ) -> Result<Applied<ClaimState, ClaimEvent>, DomainRejection>

Applies one command to one state, refusing it the way the real domain would. Must be deterministic and must not mutate state.

fn event_type(&self, event: &ClaimEvent) -> String

Stable event type label of an event, e.g. "trip.extra_added".

impl WorkflowDefinition for ClaimWorkflow

fn build_interaction( &self, state: Option<&ClaimState>, view: &ViewOf<Self>, requirement: &InteractionRequirement, ) -> Result<InteractionSpec, DomainRejection>

Binds the card to the proposal, not to the whole state.

The trip sample puts a digest of the entire case in its rebooking card’s metadata, because the entire case is what that card is about. This card is about the proposal, so the proposal is what it hashes — and the case revision is deliberately not in the metadata, because revision binding is already the interaction’s own mechanism and putting it in the payload would make the payload hash change for every unrelated edit.

type State = ClaimState

Persisted case state.

type Phase = ClaimPhase

Lifecycle phase.

type Obligation = ClaimObligation

Open obligation, possibly parameterized.

type Command = ClaimCommand

Typed command.

type Event = ClaimEvent

Typed domain event.

type Outcome = ClaimOutcome

Terminal outcome.

fn key(&self) -> WorkflowKey

Stable key.

fn version(&self) -> WorkflowVersion

Version; must change when projection semantics change (spec §8.4).

fn phase_ownership(&self, phase: &ClaimPhase) -> PhaseOwnership

Who must act in a phase. Drives the §8.4 invariants.

fn project(&self, case_ref: CaseRef, state: Option<&ClaimState>) -> ViewOf<Self>

Pure projection (I2).

fn summary(&self) -> Option<String>

One line saying what the workflow is for, shown when a message is split into requests. None, the default, shows the workflow’s key alone.

fn noun(&self) -> Option<LocalizedText>

What one record of this workflow is called, in each language its users speak («traveler», «viaggiatore»), for the sentences the runtime writes about one. None, the default, uses the workflow’s key.

fn operations(&self, view: &ViewOf<Self>) -> Vec<OperationSpec>

The operations offered in this view, with their arguments, labels and examples.

fn compile_act( &self, _state: Option<&ClaimState>, _view: &ViewOf<Self>, act: &ResolvedAct, ) -> Result<Vec<ClaimCommand>, DomainRejection>

Compiles a resolved act into typed commands (spec §21.2).

fn command_policy( &self, _state: Option<&ClaimState>, command: &ClaimCommand, ) -> CommandPolicy

Policy of a command. Unknown commands must default to CommandPolicy::conservative.

fn validate_command( &self, state: Option<&ClaimState>, command: &ClaimCommand, ) -> Result<(), DomainRejection>

Deterministic validation before execution.

fn receipts( &self, events: &[ReceiptEvent<ClaimEvent>], locale: &Locale, ) -> Vec<OperationalReceipt>

Renders receipts from committed events (spec §17.3).

fn narratable_state(&self, state: Option<&Self::State>) -> Vec<StateField>

What this case HOLDS, for the stage that answers questions.

fn glossary(&self) -> Vec<GlossaryTerm>

Terms this workflow’s users say, and what they mean here.

fn briefing( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Option<String>

Guidance for understanding a turn about a record in this view. None, the default, is ordinary.

fn obligation_sentence( &self, obligation: &Self::Obligation, ) -> Option<LocalizedText>

One obligation, in words a person would recognise.

fn obligation_act( &self, state: Option<&Self::State>, obligation: &Self::Obligation, ) -> Option<ObligationAct>

The act that answers obligation, and the values it already knows.

fn start_preconditions(&self) -> Vec<StartPrecondition>

What must already be true of another case before this workflow may be started.

fn confirmation_subject( &self, state: Option<&Self::State>, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, act: &ResolvedAct, ) -> Option<ConfirmationSubject>

What a confirmation the policy engine raises is about.

fn start_behaviour(&self) -> StartBehaviour

What starting this workflow means when a case of it is already open.

fn may_open_beside( &self, open: &[WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>], ) -> Result<(), DomainRejection>

Whether a new case may be opened while open ones are: an operation aimed at a new record, the door StartBehaviour does not govern.

fn transition_briefing( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Option<String>

What this workflow wants said while it acknowledges the turn and asks for what is still open.

fn answer_briefing( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Option<String>

What this workflow wants said while it answers a question the user asked.

fn enumerations( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Vec<DomainEnumeration>

The complete sets of values this workflow accepts, for the fields where there is one.

fn next_steps( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Vec<LocalizedText>

What the user may do next once the case owes nothing, each a sentence in the workflow’s words: the reply offers them when the case needs nothing more.

fn artifacts( &self, view: &WorkflowView<Self::Phase, Self::Obligation, Self::Outcome>, ) -> Vec<ArtifactRef>

The documents this case has, for the turn to put in front of the user.

fn nothing_changed( &self, state: Option<&Self::State>, act: &ResolvedAct, ) -> Option<LocalizedText>

Why an act that compiled nothing changed nothing, in the reader’s own words.

impl WorkflowModel<ClaimWorkflow> for ClaimModel

fn initial_states(&self) -> Vec<Option<ClaimState>>

The states exploration starts from. None means “the case does not exist yet”, which is where most workflows begin — and it never means “the case is over”, because a case’s identity outlives its content.

fn candidate_commands(&self, state: Option<&ClaimState>) -> Vec<ClaimCommand>

Commands worth trying in this state, in a stable order. Include commands you expect to be refused: the explorer checks that a refusal changes nothing.

fn simulate( &self, state: Option<&ClaimState>, command: &ClaimCommand, ) -> SimulatedTransition<ClaimState, ClaimEvent>

Applies one candidate command purely.

fn declared_outcomes(&self) -> Vec<ClaimOutcome>

Outcomes the workflow claims it can reach. The explorer reports every declared outcome no reachable state projects. The default is empty, which disables the check.