org.eclipse.bpmn2.MultiInstanceLoopCharacteristics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kie-wb-common-stunner-bpmn-emf Show documentation
Kie Workbench - Common - Stunner - BPMN Definition Set - GWT Support for Eclipse EMF/XMI
There is a newer version: 7.54.0.Final
Show newest version
/**
 * 
 * 
 * Copyright (c) 2010 SAP AG.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * Contributors:
 *    Reiner Hille-Doering (SAP AG) - initial API and implementation and/or initial documentation
 * 
 * 
 */
package org.eclipse.bpmn2;

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

/**
 * 
 * A representation of the model object 'Multi Instance Loop Characteristics'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopCardinality Loop Cardinality}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopDataInputRef Loop Data Input Ref}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopDataOutputRef Loop Data Output Ref}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getInputDataItem Input Data Item}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getOutputDataItem Output Data Item}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getComplexBehaviorDefinition Complex Behavior Definition}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getCompletionCondition Completion Condition}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getBehavior Behavior}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#isIsSequential Is Sequential}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getNoneBehaviorEventRef None Behavior Event Ref}
 *   {@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getOneBehaviorEventRef One Behavior Event Ref}
 * 
 *
 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics()
 * @model extendedMetaData="name='tMultiInstanceLoopCharacteristics' kind='elementOnly'"
 * @generated
 */
public interface MultiInstanceLoopCharacteristics extends LoopCharacteristics {
	/**
	 * Returns the value of the 'Loop Cardinality' containment reference.
	 * 
	 * 
	 * @return the value of the 'Loop Cardinality' containment reference.
	 * @see #setLoopCardinality(Expression)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_LoopCardinality()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='loopCardinality' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	Expression getLoopCardinality();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopCardinality Loop Cardinality}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Loop Cardinality' containment reference.
	 * @see #getLoopCardinality()
	 * @generated
	 */
	void setLoopCardinality(Expression value);

	/**
	 * Returns the value of the 'Loop Data Input Ref' reference.
	 * 
	 * 
	 * @return the value of the 'Loop Data Input Ref' reference.
	 * @see #setLoopDataInputRef(ItemAwareElement)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_LoopDataInputRef()
	 * @model ordered="false"
	 *        extendedMetaData="kind='element' name='loopDataInputRef' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	ItemAwareElement getLoopDataInputRef();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopDataInputRef Loop Data Input Ref}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Loop Data Input Ref' reference.
	 * @see #getLoopDataInputRef()
	 * @generated
	 */
	void setLoopDataInputRef(ItemAwareElement value);

	/**
	 * Returns the value of the 'Loop Data Output Ref' reference.
	 * 
	 * 
	 * @return the value of the 'Loop Data Output Ref' reference.
	 * @see #setLoopDataOutputRef(ItemAwareElement)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_LoopDataOutputRef()
	 * @model ordered="false"
	 *        extendedMetaData="kind='element' name='loopDataOutputRef' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	ItemAwareElement getLoopDataOutputRef();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getLoopDataOutputRef Loop Data Output Ref}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Loop Data Output Ref' reference.
	 * @see #getLoopDataOutputRef()
	 * @generated
	 */
	void setLoopDataOutputRef(ItemAwareElement value);

	/**
	 * Returns the value of the 'Input Data Item' containment reference.
	 * 
	 * 
	 * @return the value of the 'Input Data Item' containment reference.
	 * @see #setInputDataItem(DataInput)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_InputDataItem()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='inputDataItem' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	DataInput getInputDataItem();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getInputDataItem Input Data Item}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Input Data Item' containment reference.
	 * @see #getInputDataItem()
	 * @generated
	 */
	void setInputDataItem(DataInput value);

	/**
	 * Returns the value of the 'Output Data Item' containment reference.
	 * 
	 * 
	 * @return the value of the 'Output Data Item' containment reference.
	 * @see #setOutputDataItem(DataOutput)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_OutputDataItem()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='outputDataItem' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	DataOutput getOutputDataItem();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getOutputDataItem Output Data Item}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Output Data Item' containment reference.
	 * @see #getOutputDataItem()
	 * @generated
	 */
	void setOutputDataItem(DataOutput value);

	/**
	 * Returns the value of the 'Complex Behavior Definition' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.ComplexBehaviorDefinition}.
	 * 
	 * 
	 * @return the value of the 'Complex Behavior Definition' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_ComplexBehaviorDefinition()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='complexBehaviorDefinition' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getComplexBehaviorDefinition();

	/**
	 * Returns the value of the 'Completion Condition' containment reference.
	 * 
	 * 
	 * @return the value of the 'Completion Condition' containment reference.
	 * @see #setCompletionCondition(Expression)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_CompletionCondition()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='completionCondition' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	Expression getCompletionCondition();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getCompletionCondition Completion Condition}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Completion Condition' containment reference.
	 * @see #getCompletionCondition()
	 * @generated
	 */
	void setCompletionCondition(Expression value);

	/**
	 * Returns the value of the 'Behavior' attribute.
	 * The default value is "All".
	 * The literals are from the enumeration {@link org.eclipse.bpmn2.MultiInstanceBehavior}.
	 * 
	 * 
	 * @return the value of the 'Behavior' attribute.
	 * @see org.eclipse.bpmn2.MultiInstanceBehavior
	 * @see #setBehavior(MultiInstanceBehavior)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_Behavior()
	 * @model default="All" required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='behavior'"
	 * @generated
	 */
	MultiInstanceBehavior getBehavior();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getBehavior Behavior}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Behavior' attribute.
	 * @see org.eclipse.bpmn2.MultiInstanceBehavior
	 * @see #getBehavior()
	 * @generated
	 */
	void setBehavior(MultiInstanceBehavior value);

	/**
	 * Returns the value of the 'Is Sequential' attribute.
	 * The default value is "false".
	 * 
	 * 
	 * @return the value of the 'Is Sequential' attribute.
	 * @see #setIsSequential(boolean)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_IsSequential()
	 * @model default="false" required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='isSequential'"
	 * @generated
	 */
	boolean isIsSequential();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#isIsSequential Is Sequential}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Sequential' attribute.
	 * @see #isIsSequential()
	 * @generated
	 */
	void setIsSequential(boolean value);

	/**
	 * Returns the value of the 'None Behavior Event Ref' reference.
	 * 
	 * 
	 * @return the value of the 'None Behavior Event Ref' reference.
	 * @see #setNoneBehaviorEventRef(EventDefinition)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_NoneBehaviorEventRef()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='noneBehaviorEventRef'"
	 * @generated
	 */
	EventDefinition getNoneBehaviorEventRef();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getNoneBehaviorEventRef None Behavior Event Ref}' reference.
	 * 
	 * 
	 * @param value the new value of the 'None Behavior Event Ref' reference.
	 * @see #getNoneBehaviorEventRef()
	 * @generated
	 */
	void setNoneBehaviorEventRef(EventDefinition value);

	/**
	 * Returns the value of the 'One Behavior Event Ref' reference.
	 * 
	 * 
	 * @return the value of the 'One Behavior Event Ref' reference.
	 * @see #setOneBehaviorEventRef(EventDefinition)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getMultiInstanceLoopCharacteristics_OneBehaviorEventRef()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='oneBehaviorEventRef'"
	 * @generated
	 */
	EventDefinition getOneBehaviorEventRef();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.MultiInstanceLoopCharacteristics#getOneBehaviorEventRef One Behavior Event Ref}' reference.
	 * 
	 * 
	 * @param value the new value of the 'One Behavior Event Ref' reference.
	 * @see #getOneBehaviorEventRef()
	 * @generated
	 */
	void setOneBehaviorEventRef(EventDefinition value);

} // MultiInstanceLoopCharacteristics