Struct WorkflowBrief 

#[non_exhaustive]
pub struct WorkflowBrief {
    pub key: WorkflowKey,
    pub summary: Option<String>,
    pub glossary: Vec<GlossaryTerm>,
    pub startable: bool,
    pub operations: Vec<OperationSpec>,
    pub records: Vec<RecordBrief>,
    pub new_case: Vec<OperationKey>,
    pub subjects: Vec<String>,
}

A workflow as understanding sees it.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: WorkflowKey

Its key.

summary: Option<String>

One line on what it is for.

glossary: Vec<GlossaryTerm>

What its words mean.

startable: bool

Whether a new case of it may be started.

operations: Vec<OperationSpec>

Every operation offered on a record in view or on a new case, each once.

records: Vec<RecordBrief>

The records in view.

new_case: Vec<OperationKey>

The operations offered on a record that does not exist yet.

subjects: Vec<String>

What a question about it may be about: its enumerations and stated fields.

Implementations

impl WorkflowBrief

pub fn new(key: impl Into<WorkflowKey>) -> Self

A workflow with nothing in view.

pub fn summary(self, summary: impl Into<String>) -> Self

Sets its summary.

pub fn term(self, term: GlossaryTerm) -> Self

Adds a glossary term.

pub const fn startable(self) -> Self

Lets a new case be started.

pub fn operation(self, spec: OperationSpec) -> Self

Adds an operation, stamped with this workflow.

pub fn record(self, record: RecordBrief) -> Self

Adds a record.

pub fn on_new_case(self, operation: impl Into<OperationKey>) -> Self

Offers an operation on a new case.

pub fn subject(self, subject: impl Into<String>) -> Self

Adds a subject questions may be about.

pub fn spec(&self, key: &OperationKey) -> Option<&OperationSpec>

The operation with this key.

Trait Implementations

impl Clone for WorkflowBrief

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowBrief

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

Formats the value using the given formatter.