Package com.nomagic.magicdraw.cbm.profiles

Class BPMN2Profile.MultiInstanceLoopCharacteristicsStereotype

    • Field Detail

      • BEHAVIOR

        public static final java.lang.String BEHAVIOR
        The attribute behavior acts as a shortcut for specifying when events shall be thrown from an Activity instance that is about to complete. It can assume values of none, one, all, and complex, resulting in the following behavior: - None: the EventDefinition which is associated through the noneEvent association will be thrown for each instance completing; - One: the EventDefinition referenced through the oneEvent association will be thrown upon the first instance completing; - All: no Event is ever thrown; a token is produced after completion of all instances - Complex: the complexBehaviorDefinitions are consulted to determine if and which Events to throw. For the behaviors of none and one, a default SignalEventDefinition will be thrown which automatically carries the current runtime attributes of the MI Activity. Any thrown Events can be caught by boundary Events on the Multi-Instance Activity.
        See Also:
        Constant Field Values

      • COMPLETIONCONDITION

        public static final java.lang.String COMPLETIONCONDITION
        This attribute defines a Boolean Expression that when evaluated to true, cancels the remaining Activity instances and produces a token.
        See Also:
        Constant Field Values

      • COMPLEXBEHAVIORDEFINTION

        public static final java.lang.String COMPLEXBEHAVIORDEFINTION
        Controls when and which Events are thrown in case behavior is set to complex.
        See Also:
        Constant Field Values

      • INPUTDATAITEM

        public static final java.lang.String INPUTDATAITEM
        A Data Input, representing for every Activity instance the single item of the collection stored in the loopDataInput. This Data Input can be the source of DataInputAssociation to a data input of the Activity s InputOutputSpecification. The type of this Data Input MUST the scalar of the type defined for the loopDataInput.
        See Also:
        Constant Field Values

      • ISSEQUENTIAL

        public static final java.lang.String ISSEQUENTIAL
        This attribute is a flag that controls whether the Activity instances will execute sequentially or in parallel.
        See Also:
        Constant Field Values

      • LOOPCARDINALITY

        public static final java.lang.String LOOPCARDINALITY
        A numeric Expression that controls the number of Activity instances that will be created. This Expression MUST evaluate to an integer. This may be underspecified, meaning that the modeler may simply document the condition. In such a case the loop cannot be formally executed. In order to initialize a valid multi-instance, either the loopCardinality Expression or the loopDataInput MUST be specified.
        See Also:
        Constant Field Values

      • LOOPCOUNTER

        public static final java.lang.String LOOPCOUNTER
        The LoopCounter attribute is used at runtime to count the number of loops and is automatically updated by the process engine.
        See Also:
        Constant Field Values

      • LOOPDATAINPUTREF

        public static final java.lang.String LOOPDATAINPUTREF
        A reference to a DataInput which is part of the Activity s InputOutputSpecification. This DataInput is used to determine the number of Activity instances, one Activity instance per item in the collection of data stored in that DataInput element. In order to initialize a valid multi-instance, either the loopCardinality Expression or the loopDataInput MUST be specified.
        See Also:
        Constant Field Values

      • LOOPDATAOUTPUTREF

        public static final java.lang.String LOOPDATAOUTPUTREF
        This ItemAwareElement specifies the collection of data, which will be produced by the multi-instance. For Tasks it is a reference to a Data Output which is part of the Activity s InputOutputSpecification. For Sub-Processes it is a reference to a collection-valued Data Object in the context that is visible to the Sub-Processes.
        See Also:
        Constant Field Values

      • NONEBEHAVIOREVENTREF

        public static final java.lang.String NONEBEHAVIOREVENTREF
        The EventDefinition which is thrown when the behavior is set to none and an internal Activity instance has completed
        See Also:
        Constant Field Values

      • NUMBEROFACTIVEINSTANCES

        public static final java.lang.String NUMBEROFACTIVEINSTANCES
        This attribute is provided for the outer instance of the Multi-Instance Activity only. This attribute contains the number of currently active inner instances for the Multi-Instance Activity. In case of a sequential Multi-Instance Activity, this value can t be greater than 1. For parallel Multi-Instance Activities, this value can t be greater than the value contained in numberOfInstances.
        See Also:
        Constant Field Values

      • NUMBEROFCOMPLETEDINSTANCES

        public static final java.lang.String NUMBEROFCOMPLETEDINSTANCES
        This attribute is provided for the outer instance of the Multi-Instance Activity only. This attribute contains the number of already completed inner instances for the Multi-Instance Activity.
        See Also:
        Constant Field Values

      • NUMBEROFINSTANCES

        public static final java.lang.String NUMBEROFINSTANCES
        See Also:
        Constant Field Values

      • NUMBEROFTERMINATEDINSTANCES

        public static final java.lang.String NUMBEROFTERMINATEDINSTANCES
        This attribute is provided for the outer instance of the Multi-Instance Activity only. This attribute contains the number of terminated inner instances for the Multi-Instance Activity. The sum of numberOfTerminatedInstances, numberOfCompletedInstances, and numberOfActiveInstances always sums up to numberOfInstances.
        See Also:
        Constant Field Values

      • ONEBEHAVIOREVENTREF

        public static final java.lang.String ONEBEHAVIOREVENTREF
        The EventDefinition which is thrown when behavior is set to one and the first internal Activity instance has completed.
        See Also:
        Constant Field Values

      • OUTPUTDATAITEM

        public static final java.lang.String OUTPUTDATAITEM
        A Data Output, representing for every Activity instance the single item of the collection stored in the loopDataOutput. This Data Output can be the target of DataOutputAssociation to a data output of the Activity s InputOutputSpecification. The type of this Data Output MUST the scalar of the type defined for the loopDataOutput.
        See Also:
        Constant Field Values

    • Constructor Detail

      • MultiInstanceLoopCharacteristicsStereotype

        protected MultiInstanceLoopCharacteristicsStereotype​(BPMN2Profile profile)

    • Method Detail

      • getBehaviorProperty

        @CheckForNull
public Property getBehaviorProperty()

      • getCompletionConditionProperty

        @CheckForNull
public Property getCompletionConditionProperty()

      • getComplexBehaviorDefintionProperty

        @CheckForNull
public Property getComplexBehaviorDefintionProperty()

      • getInputDataItemProperty

        @CheckForNull
public Property getInputDataItemProperty()

      • getIsSequentialProperty

        @CheckForNull
public Property getIsSequentialProperty()

      • getLoopCardinalityProperty

        @CheckForNull
public Property getLoopCardinalityProperty()

      • getLoopCounterProperty

        @CheckForNull
public Property getLoopCounterProperty()

      • getLoopDataInputRefProperty

        @CheckForNull
public Property getLoopDataInputRefProperty()

      • getLoopDataOutputRefProperty

        @CheckForNull
public Property getLoopDataOutputRefProperty()

      • getNoneBehaviorEventRefProperty

        @CheckForNull
public Property getNoneBehaviorEventRefProperty()

      • getNumberOfActiveInstancesProperty

        @CheckForNull
public Property getNumberOfActiveInstancesProperty()

      • getNumberOfCompletedInstancesProperty

        @CheckForNull
public Property getNumberOfCompletedInstancesProperty()

      • getNumberOfInstancesProperty

        @CheckForNull
public Property getNumberOfInstancesProperty()

      • getNumberOfTerminatedInstancesProperty

        @CheckForNull
public Property getNumberOfTerminatedInstancesProperty()

      • getOneBehaviorEventRefProperty

        @CheckForNull
public Property getOneBehaviorEventRefProperty()

      • getOutputDataItemProperty

        @CheckForNull
public Property getOutputDataItemProperty()

      • clearBehavior

        public void clearBehavior​(Element element)

      • setCompletionCondition

        public void setCompletionCondition​(Element element,
                                   @CheckForNull
                                   java.lang.String value)

      • clearCompletionCondition

        public void clearCompletionCondition​(Element element)

      • getCompletionCondition

        @CheckForNull
public java.lang.String getCompletionCondition​(Element element)

      • setComplexBehaviorDefintion

        public void setComplexBehaviorDefintion​(Element element,
                                        @CheckForNull
                                        java.util.Collection<? extends Element> value)

      • clearComplexBehaviorDefintion

        public void clearComplexBehaviorDefintion​(Element element)

      • addComplexBehaviorDefintion

        public void addComplexBehaviorDefintion​(Element element,
                                        Element value)

      • removeComplexBehaviorDefintion

        public void removeComplexBehaviorDefintion​(Element element,
                                           Element value)

      • getComplexBehaviorDefintion

        public java.util.List<Element> getComplexBehaviorDefintion​(Element element)

      • setInputDataItem

        public void setInputDataItem​(Element element,
                             @CheckForNull
                             Element value)

      • clearInputDataItem

        public void clearInputDataItem​(Element element)

      • getInputDataItem

        @CheckForNull
public Element getInputDataItem​(Element element)

      • setIsSequential

        public void setIsSequential​(Element element,
                            @CheckForNull
                            java.lang.Boolean value)

      • clearIsSequential

        public void clearIsSequential​(Element element)

      • isIsSequential

        @CheckForNull
public java.lang.Boolean isIsSequential​(Element element)

      • setLoopCardinality

        public void setLoopCardinality​(Element element,
                               @CheckForNull
                               java.lang.String value)

      • clearLoopCardinality

        public void clearLoopCardinality​(Element element)

      • getLoopCardinality

        @CheckForNull
public java.lang.String getLoopCardinality​(Element element)

      • setLoopCounter

        public void setLoopCounter​(Element element,
                           @CheckForNull
                           java.lang.Integer value)

      • clearLoopCounter

        public void clearLoopCounter​(Element element)

      • getLoopCounter

        @CheckForNull
public java.lang.Integer getLoopCounter​(Element element)

      • setLoopDataInputRef

        public void setLoopDataInputRef​(Element element,
                                @CheckForNull
                                Element value)

      • clearLoopDataInputRef

        public void clearLoopDataInputRef​(Element element)

      • getLoopDataInputRef

        @CheckForNull
public Element getLoopDataInputRef​(Element element)

      • setLoopDataOutputRef

        public void setLoopDataOutputRef​(Element element,
                                 @CheckForNull
                                 Element value)

      • clearLoopDataOutputRef

        public void clearLoopDataOutputRef​(Element element)

      • getLoopDataOutputRef

        @CheckForNull
public Element getLoopDataOutputRef​(Element element)

      • setNoneBehaviorEventRef

        public void setNoneBehaviorEventRef​(Element element,
                                    @CheckForNull
                                    Element value)

      • clearNoneBehaviorEventRef

        public void clearNoneBehaviorEventRef​(Element element)

      • getNoneBehaviorEventRef

        @CheckForNull
public Element getNoneBehaviorEventRef​(Element element)

      • setNumberOfActiveInstances

        public void setNumberOfActiveInstances​(Element element,
                                       @CheckForNull
                                       java.lang.Integer value)

      • clearNumberOfActiveInstances

        public void clearNumberOfActiveInstances​(Element element)

      • getNumberOfActiveInstances

        @CheckForNull
public java.lang.Integer getNumberOfActiveInstances​(Element element)

      • setNumberOfCompletedInstances

        public void setNumberOfCompletedInstances​(Element element,
                                          @CheckForNull
                                          java.lang.Integer value)

      • clearNumberOfCompletedInstances

        public void clearNumberOfCompletedInstances​(Element element)

      • getNumberOfCompletedInstances

        @CheckForNull
public java.lang.Integer getNumberOfCompletedInstances​(Element element)

      • setNumberOfInstances

        public void setNumberOfInstances​(Element element,
                                 @CheckForNull
                                 java.lang.Integer value)

      • clearNumberOfInstances

        public void clearNumberOfInstances​(Element element)

      • getNumberOfInstances

        @CheckForNull
public java.lang.Integer getNumberOfInstances​(Element element)

      • setNumberOfTerminatedInstances

        public void setNumberOfTerminatedInstances​(Element element,
                                           @CheckForNull
                                           java.lang.Integer value)

      • clearNumberOfTerminatedInstances

        public void clearNumberOfTerminatedInstances​(Element element)

      • getNumberOfTerminatedInstances

        @CheckForNull
public java.lang.Integer getNumberOfTerminatedInstances​(Element element)

      • setOneBehaviorEventRef

        public void setOneBehaviorEventRef​(Element element,
                                   @CheckForNull
                                   Element value)

      • clearOneBehaviorEventRef

        public void clearOneBehaviorEventRef​(Element element)

      • getOneBehaviorEventRef

        @CheckForNull
public Element getOneBehaviorEventRef​(Element element)

      • setOutputDataItem

        public void setOutputDataItem​(Element element,
                              @CheckForNull
                              Element value)

      • clearOutputDataItem

        public void clearOutputDataItem​(Element element)

      • getOutputDataItem

        @CheckForNull
public Element getOutputDataItem​(Element element)

      • clear

        protected void clear()

      • is

        public boolean is​(@CheckForNull
                  Element element)

      • isInstance

        public static boolean isInstance​(@CheckForNull
                                 Element element)