Struct Workflow

pub struct Workflow { /* private fields */ }

Implementations

impl Workflow

pub fn build(name: &str) -> WorkflowBuilder

Create a new unregistered Workflow with no activities. Returns a WorkflowBuilder that can be used to configure and register the new Workflow.

To get a copy of an existing registered Workflow use Workflow::clone_to.

pub fn clone_to(&self, name: &str) -> WorkflowBuilder

Make a new unregistered Workflow, copying all activities and the execution strategy. Returns a WorkflowBuilder that can be used to configure and register the new Workflow.

• name - the name for the new Workflow

pub fn clone_to_with_root( &self, name: &str, root_activity: &str, ) -> WorkflowBuilder

Make a new unregistered Workflow, copying all activities, within root_activity, and the execution strategy.

• name - the name for the new Workflow
• root_activity - perform the clone operation with this activity as the root

pub fn get(name: &str) -> Option<Ref<Workflow>>

Get an existing Workflow by name.

pub fn cloned(name: &str) -> Option<WorkflowBuilder>

Clone the existing Workflow named name. Returns a WorkflowBuilder that can be used to configure and register the new Workflow.

pub fn list() -> Array<Workflow>

List of all registered Workflow’s

pub fn name(&self) -> String

pub fn contains(&self, activity: &str) -> bool

Determine if an Activity exists in this Workflow.

pub fn configuration(&self) -> String

Retrieve the configuration as an adjacency list in JSON for the Workflow.

pub fn configuration_with_activity(&self, activity: &str) -> String

Retrieve the configuration as an adjacency list in JSON for the Workflow, just for the given activity.

activity - return the configuration for the activity

pub fn registered(&self) -> bool

Whether this Workflow is registered or not. A Workflow becomes immutable once registered.

pub fn size(&self) -> usize

pub fn activity(&self, name: &str) -> Option<Ref<Activity>>

Retrieve the Activity object for the specified name.

pub fn activity_roots(&self, activity: &str) -> Array<BnString>

Retrieve the list of activity roots for the Workflow, or if specified just for the given activity.

• activity - if specified, return the roots for the activity

pub fn subactivities(&self, activity: &str, immediate: bool) -> Array<BnString>

Retrieve the list of all activities, or optionally a filtered list.

• activity - if specified, return the direct children and optionally the descendants of the activity (includes activity)
• immediate - whether to include only direct children of activity or all descendants

pub fn graph( &self, activity: &str, sequential: Option<bool>, ) -> Option<Ref<FlowGraph>>

Generate a FlowGraph object for the current Workflow and optionally show it in the UI.

• activity - if specified, generate the Flowgraph using activity as the root
• sequential - whether to generate a Composite or Sequential style graph

pub fn show_metrics(&self)

Not yet implemented.

pub fn show_topology(&self)

Show the Workflow topology in the UI.

pub fn show_trace(&self)

Not yet implemented.

Trait Implementations

impl CoreArrayProvider for Workflow

type Raw = *mut BNWorkflow

type Context = ()

type Wrapped<'a> = Guard<'a, Workflow>

impl ToOwned for Workflow

type Owned = Ref<Workflow>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.