org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics Maven / Gradle / Ivy

Go to download
/**
 * Copyright (C) 2023 BonitaSoft S.A.
 * BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2.0 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package org.omg.spec.bpmn.model;

import javax.xml.namespace.QName;

import org.eclipse.emf.common.util.EList;

/**
 * 
 * A representation of the model object 'TMulti Instance Loop Characteristics'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopCardinality Loop Cardinality}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopDataInputRef Loop Data Input Ref}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopDataOutputRef Loop Data Output Ref}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getInputDataItem Input Data Item}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getOutputDataItem Output Data Item}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getComplexBehaviorDefinition Complex Behavior Definition}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getCompletionCondition Completion Condition}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getBehavior Behavior}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#isIsSequential Is Sequential}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getNoneBehaviorEventRef None Behavior Event Ref}
 *   {@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getOneBehaviorEventRef One Behavior Event Ref}
 * 
 *
 * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics()
 * @model extendedMetaData="name='tMultiInstanceLoopCharacteristics' kind='elementOnly'"
 * @generated
 */
public interface TMultiInstanceLoopCharacteristics extends TLoopCharacteristics {

    /**
     * Returns the value of the 'Loop Cardinality' containment reference.
     * 
     * 
     * @return the value of the 'Loop Cardinality' containment reference.
     * @see #setLoopCardinality(TExpression)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_LoopCardinality()
     * @model containment="true"
     *        extendedMetaData="kind='element' name='loopCardinality' namespace='##targetNamespace'"
     * @generated
     */
    TExpression getLoopCardinality();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopCardinality Loop Cardinality}' containment reference.
     * 
     * 
     * @param value the new value of the 'Loop Cardinality' containment reference.
     * @see #getLoopCardinality()
     * @generated
     */
    void setLoopCardinality(TExpression value);

    /**
     * Returns the value of the 'Loop Data Input Ref' attribute.
     * 
     * 
     * @return the value of the 'Loop Data Input Ref' attribute.
     * @see #setLoopDataInputRef(QName)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_LoopDataInputRef()
     * @model dataType="org.eclipse.emf.ecore.xml.type.QName"
     *        extendedMetaData="kind='element' name='loopDataInputRef' namespace='##targetNamespace'"
     * @generated
     */
    QName getLoopDataInputRef();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopDataInputRef Loop Data Input Ref}' attribute.
     * 
     * 
     * @param value the new value of the 'Loop Data Input Ref' attribute.
     * @see #getLoopDataInputRef()
     * @generated
     */
    void setLoopDataInputRef(QName value);

    /**
     * Returns the value of the 'Loop Data Output Ref' attribute.
     * 
     * 
     * @return the value of the 'Loop Data Output Ref' attribute.
     * @see #setLoopDataOutputRef(QName)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_LoopDataOutputRef()
     * @model dataType="org.eclipse.emf.ecore.xml.type.QName"
     *        extendedMetaData="kind='element' name='loopDataOutputRef' namespace='##targetNamespace'"
     * @generated
     */
    QName getLoopDataOutputRef();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getLoopDataOutputRef Loop Data Output Ref}' attribute.
     * 
     * 
     * @param value the new value of the 'Loop Data Output Ref' attribute.
     * @see #getLoopDataOutputRef()
     * @generated
     */
    void setLoopDataOutputRef(QName value);

    /**
     * Returns the value of the 'Input Data Item' containment reference.
     * 
     * 
     * @return the value of the 'Input Data Item' containment reference.
     * @see #setInputDataItem(TDataInput)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_InputDataItem()
     * @model containment="true"
     *        extendedMetaData="kind='element' name='inputDataItem' namespace='##targetNamespace'"
     * @generated
     */
    TDataInput getInputDataItem();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getInputDataItem Input Data Item}' containment reference.
     * 
     * 
     * @param value the new value of the 'Input Data Item' containment reference.
     * @see #getInputDataItem()
     * @generated
     */
    void setInputDataItem(TDataInput value);

    /**
     * Returns the value of the 'Output Data Item' containment reference.
     * 
     * 
     * @return the value of the 'Output Data Item' containment reference.
     * @see #setOutputDataItem(TDataOutput)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_OutputDataItem()
     * @model containment="true"
     *        extendedMetaData="kind='element' name='outputDataItem' namespace='##targetNamespace'"
     * @generated
     */
    TDataOutput getOutputDataItem();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getOutputDataItem Output Data Item}' containment reference.
     * 
     * 
     * @param value the new value of the 'Output Data Item' containment reference.
     * @see #getOutputDataItem()
     * @generated
     */
    void setOutputDataItem(TDataOutput value);

    /**
     * Returns the value of the 'Complex Behavior Definition' containment reference list.
     * The list contents are of type {@link org.omg.spec.bpmn.model.TComplexBehaviorDefinition}.
     * 
     * 
     * @return the value of the 'Complex Behavior Definition' containment reference list.
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_ComplexBehaviorDefinition()
     * @model containment="true"
     *        extendedMetaData="kind='element' name='complexBehaviorDefinition' namespace='##targetNamespace'"
     * @generated
     */
    EList getComplexBehaviorDefinition();

    /**
     * Returns the value of the 'Completion Condition' containment reference.
     * 
     * 
     * @return the value of the 'Completion Condition' containment reference.
     * @see #setCompletionCondition(TExpression)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_CompletionCondition()
     * @model containment="true"
     *        extendedMetaData="kind='element' name='completionCondition' namespace='##targetNamespace'"
     * @generated
     */
    TExpression getCompletionCondition();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getCompletionCondition Completion Condition}' containment reference.
     * 
     * 
     * @param value the new value of the 'Completion Condition' containment reference.
     * @see #getCompletionCondition()
     * @generated
     */
    void setCompletionCondition(TExpression value);

    /**
     * Returns the value of the 'Behavior' attribute.
     * The default value is "All".
     * The literals are from the enumeration {@link org.omg.spec.bpmn.model.TMultiInstanceFlowCondition}.
     * 
     * 
     * @return the value of the 'Behavior' attribute.
     * @see org.omg.spec.bpmn.model.TMultiInstanceFlowCondition
     * @see #isSetBehavior()
     * @see #unsetBehavior()
     * @see #setBehavior(TMultiInstanceFlowCondition)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_Behavior()
     * @model default="All" unsettable="true"
     *        extendedMetaData="kind='attribute' name='behavior'"
     * @generated
     */
    TMultiInstanceFlowCondition getBehavior();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getBehavior Behavior}' attribute.
     * 
     * 
     * @param value the new value of the 'Behavior' attribute.
     * @see org.omg.spec.bpmn.model.TMultiInstanceFlowCondition
     * @see #isSetBehavior()
     * @see #unsetBehavior()
     * @see #getBehavior()
     * @generated
     */
    void setBehavior(TMultiInstanceFlowCondition value);

    /**
     * Unsets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getBehavior Behavior}' attribute.
     * 
     * 
     * @see #isSetBehavior()
     * @see #getBehavior()
     * @see #setBehavior(TMultiInstanceFlowCondition)
     * @generated
     */
    void unsetBehavior();

    /**
     * Returns whether the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getBehavior Behavior}' attribute is set.
     * 
     * 
     * @return whether the value of the 'Behavior' attribute is set.
     * @see #unsetBehavior()
     * @see #getBehavior()
     * @see #setBehavior(TMultiInstanceFlowCondition)
     * @generated
     */
    boolean isSetBehavior();

    /**
     * Returns the value of the 'Is Sequential' attribute.
     * The default value is "false".
     * 
     * 
     * @return the value of the 'Is Sequential' attribute.
     * @see #isSetIsSequential()
     * @see #unsetIsSequential()
     * @see #setIsSequential(boolean)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_IsSequential()
     * @model default="false" unsettable="true" dataType="org.eclipse.emf.ecore.xml.type.Boolean"
     *        extendedMetaData="kind='attribute' name='isSequential'"
     * @generated
     */
    boolean isIsSequential();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#isIsSequential Is Sequential}' attribute.
     * 
     * 
     * @param value the new value of the 'Is Sequential' attribute.
     * @see #isSetIsSequential()
     * @see #unsetIsSequential()
     * @see #isIsSequential()
     * @generated
     */
    void setIsSequential(boolean value);

    /**
     * Unsets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#isIsSequential Is Sequential}' attribute.
     * 
     * 
     * @see #isSetIsSequential()
     * @see #isIsSequential()
     * @see #setIsSequential(boolean)
     * @generated
     */
    void unsetIsSequential();

    /**
     * Returns whether the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#isIsSequential Is Sequential}' attribute is set.
     * 
     * 
     * @return whether the value of the 'Is Sequential' attribute is set.
     * @see #unsetIsSequential()
     * @see #isIsSequential()
     * @see #setIsSequential(boolean)
     * @generated
     */
    boolean isSetIsSequential();

    /**
     * Returns the value of the 'None Behavior Event Ref' attribute.
     * 
     * 
     * @return the value of the 'None Behavior Event Ref' attribute.
     * @see #setNoneBehaviorEventRef(QName)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_NoneBehaviorEventRef()
     * @model dataType="org.eclipse.emf.ecore.xml.type.QName"
     *        extendedMetaData="kind='attribute' name='noneBehaviorEventRef'"
     * @generated
     */
    QName getNoneBehaviorEventRef();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getNoneBehaviorEventRef None Behavior Event Ref}' attribute.
     * 
     * 
     * @param value the new value of the 'None Behavior Event Ref' attribute.
     * @see #getNoneBehaviorEventRef()
     * @generated
     */
    void setNoneBehaviorEventRef(QName value);

    /**
     * Returns the value of the 'One Behavior Event Ref' attribute.
     * 
     * 
     * @return the value of the 'One Behavior Event Ref' attribute.
     * @see #setOneBehaviorEventRef(QName)
     * @see org.omg.spec.bpmn.model.ModelPackage#getTMultiInstanceLoopCharacteristics_OneBehaviorEventRef()
     * @model dataType="org.eclipse.emf.ecore.xml.type.QName"
     *        extendedMetaData="kind='attribute' name='oneBehaviorEventRef'"
     * @generated
     */
    QName getOneBehaviorEventRef();

    /**
     * Sets the value of the '{@link org.omg.spec.bpmn.model.TMultiInstanceLoopCharacteristics#getOneBehaviorEventRef One Behavior Event Ref}' attribute.
     * 
     * 
     * @param value the new value of the 'One Behavior Event Ref' attribute.
     * @see #getOneBehaviorEventRef()
     * @generated
     */
    void setOneBehaviorEventRef(QName value);

} // TMultiInstanceLoopCharacteristics