org.omg.bpmn.bpmn2.ChoreographyActivity Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.omg.bpmn.model Show documentation
Ecore and generated code for org.omg.bpmn2
The newest version!
/*
 * Copyright (c) 2012 - 2024 Data In Motion and others.
 * All rights reserved. 
 * 
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 * 
 * SPDX-License-Identifier: EPL-2.0
 * 
 * Contributors:
 *      Mark Hoffmann - initial API and implementation
 */
package org.omg.bpmn.bpmn2;

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

import org.osgi.annotation.versioning.ProviderType;

/**
 * 
 * A representation of the model object 'Choreography Activity'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.omg.bpmn.bpmn2.ChoreographyActivity#getParticipantRefs Participant Refs}
 *   {@link org.omg.bpmn.bpmn2.ChoreographyActivity#getCorrelationKeys Correlation Keys}
 *   {@link org.omg.bpmn.bpmn2.ChoreographyActivity#getInitiatingParticipantRef Initiating Participant Ref}
 *   {@link org.omg.bpmn.bpmn2.ChoreographyActivity#getLoopType Loop Type}
 * 
 *
 * @see org.omg.bpmn.bpmn2.Bpmn2Package#getChoreographyActivity()
 * @model abstract="true"
 *        extendedMetaData="name='tChoreographyActivity' kind='elementOnly'"
 * @generated
 */
@ProviderType
public interface ChoreographyActivity extends FlowNode {
	/**
	 * Returns the value of the 'Participant Refs' reference list.
	 * The list contents are of type {@link org.omg.bpmn.bpmn2.Participant}.
	 * 
	 * 
	 * @return the value of the 'Participant Refs' reference list.
	 * @see org.omg.bpmn.bpmn2.Bpmn2Package#getChoreographyActivity_ParticipantRefs()
	 * @model lower="2" ordered="false"
	 *        extendedMetaData="kind='element' name='participantRef' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getParticipantRefs();

	/**
	 * Returns the value of the 'Correlation Keys' containment reference list.
	 * The list contents are of type {@link org.omg.bpmn.bpmn2.CorrelationKey}.
	 * 
	 * 
	 * @return the value of the 'Correlation Keys' containment reference list.
	 * @see org.omg.bpmn.bpmn2.Bpmn2Package#getChoreographyActivity_CorrelationKeys()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='correlationKey' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getCorrelationKeys();

	/**
	 * Returns the value of the 'Initiating Participant Ref' reference.
	 * 
	 * 
	 * @return the value of the 'Initiating Participant Ref' reference.
	 * @see #setInitiatingParticipantRef(Participant)
	 * @see org.omg.bpmn.bpmn2.Bpmn2Package#getChoreographyActivity_InitiatingParticipantRef()
	 * @model required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='initiatingParticipantRef'"
	 * @generated
	 */
	Participant getInitiatingParticipantRef();

	/**
	 * Sets the value of the '{@link org.omg.bpmn.bpmn2.ChoreographyActivity#getInitiatingParticipantRef Initiating Participant Ref}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Initiating Participant Ref' reference.
	 * @see #getInitiatingParticipantRef()
	 * @generated
	 */
	void setInitiatingParticipantRef(Participant value);

	/**
	 * Returns the value of the 'Loop Type' attribute.
	 * The default value is "None".
	 * The literals are from the enumeration {@link org.omg.bpmn.bpmn2.ChoreographyLoopType}.
	 * 
	 * 
	 * @return the value of the 'Loop Type' attribute.
	 * @see org.omg.bpmn.bpmn2.ChoreographyLoopType
	 * @see #setLoopType(ChoreographyLoopType)
	 * @see org.omg.bpmn.bpmn2.Bpmn2Package#getChoreographyActivity_LoopType()
	 * @model default="None" ordered="false"
	 *        extendedMetaData="kind='attribute' name='loopType'"
	 * @generated
	 */
	ChoreographyLoopType getLoopType();

	/**
	 * Sets the value of the '{@link org.omg.bpmn.bpmn2.ChoreographyActivity#getLoopType Loop Type}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Loop Type' attribute.
	 * @see org.omg.bpmn.bpmn2.ChoreographyLoopType
	 * @see #getLoopType()
	 * @generated
	 */
	void setLoopType(ChoreographyLoopType value);

} // ChoreographyActivity