data_output

Represents a Data Output.

CLASS	DESCRIPTION
DataOutput	A Data Output is a declaration that a particular kind of data will be used as output of the ioSpecification.

Classes

DataOutput dataclass

DataOutput(
    *,
    id: Optional[str] = None,
    documentation: list[Documentation] = list(),
    extension_elements: Optional[ExtensionElements] = None,
    data_state: Optional[DataState] = None,
    name: Optional[str] = None,
    item_subject_ref: Optional[str] = None,
    is_collection: bool = False
)

Bases: BaseElement

A Data Output is a declaration that a particular kind of data will be used as output of the ioSpecification.

ATTRIBUTE	DESCRIPTION
data_state	A reference to the DataState, which defines certain states for the data contained in the Item. TYPE: Optional[DataState]
is_collection	Defines if the DataOutput represents a collection of elements. TYPE: bool
item_subject_ref	Specification of the items that are stored by the DataOutput. TYPE: Optional[str]
name	A descriptive name for the data output. TYPE: Optional[str]

Attributes

data_state class-attribute instance-attribute

data_state: Optional[DataState] = field(
    default=None,
    metadata={
        "name": "dataState",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
    },
)

A reference to the DataState, which defines certain states for the data contained in the Item.

is_collection class-attribute instance-attribute

is_collection: bool = field(
    default=False, metadata={"name": "isCollection", "type": "Attribute"}
)

Defines if the DataOutput represents a collection of elements.

It is necessary when item_subject_ref is None.

If item_subject_ref is not None, then this attribute MUST have the same value as the is_collection attribute of the referenced item_subject_ref. The default value for this attribute is false.

item_subject_ref class-attribute instance-attribute

item_subject_ref: Optional[str] = field(
    default=None,
    metadata={
        "name": "itemSubjectRef",
        "type": "Attribute",
        "is_reference": True,
    },
)

Specification of the items that are stored by the DataOutput.

name class-attribute instance-attribute

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

A descriptive name for the data output.

Functions