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

Go to download
/**
 * 
 * 
 * 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 'Choreography Activity'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.eclipse.bpmn2.ChoreographyActivity#getParticipantRefs Participant Refs}
 *   {@link org.eclipse.bpmn2.ChoreographyActivity#getCorrelationKeys Correlation Keys}
 *   {@link org.eclipse.bpmn2.ChoreographyActivity#getInitiatingParticipantRef Initiating Participant Ref}
 *   {@link org.eclipse.bpmn2.ChoreographyActivity#getLoopType Loop Type}
 * 
 *
 * @see org.eclipse.bpmn2.Bpmn2Package#getChoreographyActivity()
 * @model abstract="true"
 *        extendedMetaData="name='tChoreographyActivity' kind='elementOnly'"
 * @generated
 */
public interface ChoreographyActivity extends FlowNode {
	/**
	 * Returns the value of the 'Participant Refs' reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.Participant}.
	 * 
	 * 
	 * @return the value of the 'Participant Refs' reference list.
	 * @see org.eclipse.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.eclipse.bpmn2.CorrelationKey}.
	 * 
	 * 
	 * @return the value of the 'Correlation Keys' containment reference list.
	 * @see org.eclipse.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.eclipse.bpmn2.Bpmn2Package#getChoreographyActivity_InitiatingParticipantRef()
	 * @model required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='initiatingParticipantRef'"
	 * @generated
	 */
	Participant getInitiatingParticipantRef();

	/**
	 * Sets the value of the '{@link org.eclipse.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.eclipse.bpmn2.ChoreographyLoopType}.
	 * 
	 * 
	 * @return the value of the 'Loop Type' attribute.
	 * @see org.eclipse.bpmn2.ChoreographyLoopType
	 * @see #setLoopType(ChoreographyLoopType)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getChoreographyActivity_LoopType()
	 * @model default="None" required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='loopType'"
	 * @generated
	 */
	ChoreographyLoopType getLoopType();

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

} // ChoreographyActivity