Struct Workflow

pub struct Workflow { /* private fields */ }

Implementations

impl Workflow

pub fn new<S: BnStrCompatible>(name: S) -> Ref<Self>

Create a new unregistered Workflow with no activities.

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

pub fn clone_to<S: BnStrCompatible + Clone>(&self, name: S) -> Ref<Workflow>

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

• name - the name for the new Workflow

pub fn clone_to_with_root<S: BnStrCompatible, A: BnStrCompatible>( &self, name: S, root_activity: A, ) -> Ref<Workflow>

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 instance<S: BnStrCompatible>(name: S) -> Ref<Workflow>

pub fn list() -> Array<Workflow>

List of all registered Workflow’s

pub fn name(&self) -> BnString

pub fn register(&self) -> Result<(), ()>

Register this Workflow, making it immutable and available for use.

pub fn register_with_config<S: BnStrCompatible>( &self, config: S, ) -> Result<(), ()>

Register this Workflow, making it immutable and available for use.

• configuration - a JSON representation of the workflow configuration

pub fn register_activity( &self, activity: &Activity, ) -> Result<Ref<Activity>, ()>

Register an Activity with this Workflow.

• activity - the Activity to register

pub fn register_activity_with_subactivities<I>( &self, activity: &Activity, subactivities: I, ) -> Result<Ref<Activity>, ()>

where I: IntoIterator, I::Item: BnStrCompatible,

Register an Activity with this Workflow.

• activity - the Activity to register
• subactivities - the list of Activities to assign

pub fn contains<A: BnStrCompatible>(&self, activity: A) -> bool

Determine if an Activity exists in this Workflow.

pub fn configuration(&self) -> BnString

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

pub fn configuration_with_activity<A: BnStrCompatible>( &self, activity: A, ) -> BnString

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<A: BnStrCompatible>(&self, name: A) -> Option<Ref<Activity>>

Retrieve the Activity object for the specified name.

pub fn activity_roots<A: BnStrCompatible>(&self, activity: A) -> 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<A: BnStrCompatible>( &self, activity: A, 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 assign_subactivities<A, I>(&self, activity: A, activities: I) -> bool

where A: BnStrCompatible, I: IntoIterator, I::Item: BnStrCompatible,

Assign the list of activities as the new set of children for the specified activity.

• activity - the Activity node to assign children
• activities - the list of Activities to assign

pub fn clear(&self) -> bool

Remove all Activity nodes from this Workflow.

pub fn insert<A, I>(&self, activity: A, activities: I) -> bool

where A: BnStrCompatible, I: IntoIterator, I::Item: BnStrCompatible,

Insert the list of activities before the specified activity and at the same level.

• activity - the Activity node for which to insert activities before
• activities - the list of Activities to insert

pub fn insert_after<A, I>(&self, activity: A, activities: I) -> bool

where A: BnStrCompatible, I: IntoIterator, I::Item: BnStrCompatible,

Insert the list of activities after the specified activity and at the same level.

• activity - the Activity node for which to insert activities after
• activities - the list of Activities to insert

pub fn remove<A: BnStrCompatible>(&self, activity: A) -> bool

Remove the specified activity

pub fn replace<A: BnStrCompatible, N: BnStrCompatible>( &self, activity: A, new_activity: N, ) -> bool

Replace the specified activity.

• activity - the Activity to replace
• new_activity - the replacement Activity

pub fn graph<A: BnStrCompatible>( &self, activity: A, 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.