Skip to content

input_set

Represents a BPMN 2.0 input set.

CLASS DESCRIPTION
InputSet

An InputSet is a collection of DataInput elements that define a valid set of inputs for an ioSpecification.

Classes

InputSet dataclass

InputSet(
    *,
    id: Optional[str] = None,
    documentation: list[Documentation] = list(),
    extension_elements: Optional[ExtensionElements] = None,
    data_input_refs: list[str] = list(),
    optional_input_refs: list[str] = list(),
    while_executing_input_refs: list[str] = list(),
    output_set_refs: list[str] = list(),
    name: Optional[str] = None
)

Bases: BaseElement

An InputSet is a collection of DataInput elements that define a valid set of inputs for an ioSpecification.

ATTRIBUTE DESCRIPTION
data_input_refs

The DataInput elements that collectively make up this data requirement.

TYPE: list[str]

name

A descriptive name for the input set.

TYPE: Optional[str]

optional_input_refs

The DataInput elements that are part of the InputSet can be “unavailable” when the Activity starts executing.

TYPE: list[str]

output_set_refs

Specifies an Input/Output rule that defines which OutputSet is to be created when this InputSet is valid.

TYPE: list[str]

while_executing_input_refs

The DataInput elements that are a part of the InputSet can be evaluated while the Activity is executing.

TYPE: list[str]

Attributes

data_input_refs class-attribute instance-attribute
data_input_refs: list[str] = field(
    default_factory=list,
    metadata={
        "name": "dataInputRefs",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

The DataInput elements that collectively make up this data requirement.

name class-attribute instance-attribute
name: Optional[str] = field(default=None, metadata={'type': 'Attribute'})

A descriptive name for the input set.

optional_input_refs class-attribute instance-attribute
optional_input_refs: list[str] = field(
    default_factory=list,
    metadata={
        "name": "optionalInputRefs",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

The DataInput elements that are part of the InputSet can be “unavailable” when the Activity starts executing.

This association must reference a DataInput that is listed in data_input_refs.

output_set_refs class-attribute instance-attribute
output_set_refs: list[str] = field(
    default_factory=list,
    metadata={
        "name": "outputSetRefs",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

Specifies an Input/Output rule that defines which OutputSet is to be created when this InputSet is valid.

This attribute is paired with the inputSetRefs attribute of OutputSets.

while_executing_input_refs class-attribute instance-attribute
while_executing_input_refs: list[str] = field(
    default_factory=list,
    metadata={
        "name": "whileExecutingInputRefs",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

The DataInput elements that are a part of the InputSet can be evaluated while the Activity is executing.

This association must reference a DataInput that is listed in the dataInputRefs.

Functions