Struct vf_rs::vf::builders::CommitmentBuilder

pub struct CommitmentBuilder<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> { /* fields omitted */ }

Builder for Commitment.

Implementations

impl<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE> CommitmentBuilder<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

pub fn action<VALUE: Into<Action>>(self, value: VALUE) -> Self

Defines the kind of flow, such as consume, produce, work, transfer, etc.

pub fn agreed_in<VALUE: Into<Url>>(self, value: VALUE) -> Self

Reference to an agreement between agents which specifies the rules, terms, policies, calculations, etc. which govern this flow.

pub fn at_location<VALUE: Into<SpatialThing>>(self, value: VALUE) -> Self

The place where an intent, commitment, or economic event occurs. Usually mappable.

pub fn clause_of<VALUE: Into<AGREEMENT>>(self, value: VALUE) -> Self

This commitment is part of the agreement.

pub fn created<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

pub fn due<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

The time something is expected to be complete.

pub fn effort_quantity<VALUE: Into<Measure>>(self, value: VALUE) -> Self

The amount and unit of the work or use or citation effort-based action. This is often a time duration, but also could be cycle counts or other measures of effort or usefulness.

pub fn finished<VALUE: Into<bool>>(self, value: VALUE) -> Self

The commitment or intent or process is complete or not. This is irrespective of if the original goal has been met, and indicates that no more will be done.

pub fn has_beginning<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

The planned or actual beginning of a flow or process.

pub fn has_end<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

The planned or actual end of a flow or process.

pub fn has_point_in_time<VALUE: Into<DateTime<Utc>>>(self, value: VALUE) -> Self

The planned or actual time of a flow; can be used instead of hasBeginning and hasEnd, if so, hasBeginning and hasEnd should be able to be returned with this value.

pub fn in_scope_of<VALUE: Into<Vec<Url>>>(self, value: VALUE) -> Self

Grouping around something to create a boundary or context, used for documenting, accounting, planning.

pub fn independent_demand_of<VALUE: Into<PLAN>>(self, value: VALUE) -> Self

Represents a desired deliverable expected from this plan.

pub fn input_of<VALUE: Into<PROCESS>>(self, value: VALUE) -> Self

Relates an input flow to it's process.

pub fn name<VALUE: Into<String>>(self, value: VALUE) -> Self

An informal or formal textual identifier for an object. Does not imply uniqueness.

pub fn note<VALUE: Into<String>>(self, value: VALUE) -> Self

pub fn output_of<VALUE: Into<PROCESS>>(self, value: VALUE) -> Self

Relates an output flow to it's process.

pub fn provider<VALUE: Into<AGENT>>(self, value: VALUE) -> Self

The economic agent from whom the intended, committed, or actual economic event is initiated.

pub fn receiver<VALUE: Into<AGENT>>(self, value: VALUE) -> Self

The economic agent whom the intended, committed, or actual economic event is for.

pub fn resource_classified_as<VALUE: Into<Vec<Url>>>(self, value: VALUE) -> Self

References a concept in a common taxonomy or other classification scheme for purposes of categorization or grouping.

pub fn resource_conforms_to<VALUE: Into<RESOURCESPECIFICATION>>(
    self,
    value: VALUE
) -> Self

The primary resource specification or definition of an existing or potential economic resource. A resource will have only one, as this specifies exactly what the resource is.

pub fn resource_inventoried_as<VALUE: Into<ECONOMICRESOURCE>>(
    self,
    value: VALUE
) -> Self

Economic resource involved in the flow.

pub fn resource_quantity<VALUE: Into<Measure>>(self, value: VALUE) -> Self

The amount and unit of the economic resource counted or inventoried.

pub fn build(
    self
) -> Result<Commitment<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>, String>

Builds a new Commitment.

Errors

If a required field has not been initialized.

Trait Implementations

impl<AGREEMENT: Default, PLAN: Default, PROCESS: Default, AGENT: Default, RESOURCESPECIFICATION: Default, ECONOMICRESOURCE: Default> Default for CommitmentBuilder<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

fn default(
) -> CommitmentBuilder<AGREEMENT, PLAN, PROCESS, AGENT, RESOURCESPECIFICATION, ECONOMICRESOURCE>

Returns the "default value" for a type.