operation

Represents an Operation.

CLASS	DESCRIPTION
Operation	An Operation defines Messages that are consumed and, optionally, produced when the Operation is called.

Classes

Operation dataclass

Operation(
    *,
    id: Optional[str] = None,
    documentation: list[Documentation] = list(),
    extension_elements: Optional[ExtensionElements] = None,
    in_message_ref: str,
    out_message_ref: Optional[str] = None,
    error_ref: list[str] = list(),
    name: str,
    implementation_ref: Optional[str] = None
)

Bases: BaseElement

An Operation defines Messages that are consumed and, optionally, produced when the Operation is called.

ATTRIBUTE	DESCRIPTION
error_ref	This attribute specifies errors that the Operation may return. TYPE: list[str]
in_message_ref	This attribute specifies the input Message of the Operation. TYPE: str
name	The descriptive name of the element. TYPE: str
out_message_ref	This attribute specifies the output Message of the operation. TYPE: Optional[str]

Attributes

error_ref class-attribute instance-attribute

error_ref: list[str] = field(
    default_factory=list,
    metadata={
        "name": "errorRef",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

This attribute specifies errors that the Operation may return.

An Operation may refer to zero or more Error elements.

in_message_ref class-attribute instance-attribute

in_message_ref: str = field(
    metadata={
        "name": "inMessageRef",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "required": True,
        "is_reference": True,
    }
)

This attribute specifies the input Message of the Operation.

An Operation has exactly one input Message.

name class-attribute instance-attribute

name: str = field(metadata={'type': 'Attribute', 'required': True})

The descriptive name of the element.

out_message_ref class-attribute instance-attribute

out_message_ref: Optional[str] = field(
    default=None,
    metadata={
        "name": "outMessageRef",
        "type": "Element",
        "namespace": "http://www.omg.org/spec/BPMN/20100524/MODEL",
        "is_reference": True,
    },
)

This attribute specifies the output Message of the operation.

An Operation has at most one input Message.

Functions