org.eclipse.bpmn2.Collaboration 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 'Collaboration'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.eclipse.bpmn2.Collaboration#getParticipants Participants}
 *   {@link org.eclipse.bpmn2.Collaboration#getMessageFlows Message Flows}
 *   {@link org.eclipse.bpmn2.Collaboration#getArtifacts Artifacts}
 *   {@link org.eclipse.bpmn2.Collaboration#getConversations Conversations}
 *   {@link org.eclipse.bpmn2.Collaboration#getConversationAssociations Conversation Associations}
 *   {@link org.eclipse.bpmn2.Collaboration#getParticipantAssociations Participant Associations}
 *   {@link org.eclipse.bpmn2.Collaboration#getMessageFlowAssociations Message Flow Associations}
 *   {@link org.eclipse.bpmn2.Collaboration#getCorrelationKeys Correlation Keys}
 *   {@link org.eclipse.bpmn2.Collaboration#getChoreographyRef Choreography Ref}
 *   {@link org.eclipse.bpmn2.Collaboration#getConversationLinks Conversation Links}
 *   {@link org.eclipse.bpmn2.Collaboration#isIsClosed Is Closed}
 *   {@link org.eclipse.bpmn2.Collaboration#getName Name}
 * 
 *
 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration()
 * @model extendedMetaData="name='tCollaboration' kind='elementOnly'"
 * @generated
 */
public interface Collaboration extends RootElement {
	/**
	 * Returns the value of the 'Participants' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.Participant}.
	 * 
	 * 
	 * @return the value of the 'Participants' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_Participants()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='participant' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getParticipants();

	/**
	 * Returns the value of the 'Message Flows' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.MessageFlow}.
	 * 
	 * 
	 * @return the value of the 'Message Flows' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_MessageFlows()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='messageFlow' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getMessageFlows();

	/**
	 * Returns the value of the 'Artifacts' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.Artifact}.
	 * 
	 * 
	 * @return the value of the 'Artifacts' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_Artifacts()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='artifact' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL' group='http://www.omg.org/spec/BPMN/20100524/MODEL#artifact'"
	 * @generated
	 */
	EList getArtifacts();

	/**
	 * Returns the value of the 'Conversations' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.ConversationNode}.
	 * 
	 * 
	 * @return the value of the 'Conversations' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_Conversations()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='conversationNode' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL' group='http://www.omg.org/spec/BPMN/20100524/MODEL#conversationNode'"
	 * @generated
	 */
	EList getConversations();

	/**
	 * Returns the value of the 'Conversation Associations' containment reference.
	 * 
	 * 
	 * @return the value of the 'Conversation Associations' containment reference.
	 * @see #setConversationAssociations(ConversationAssociation)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_ConversationAssociations()
	 * @model containment="true" required="true" ordered="false"
	 *        extendedMetaData="kind='element' name='conversationAssociation' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	ConversationAssociation getConversationAssociations();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.Collaboration#getConversationAssociations Conversation Associations}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Conversation Associations' containment reference.
	 * @see #getConversationAssociations()
	 * @generated
	 */
	void setConversationAssociations(ConversationAssociation value);

	/**
	 * Returns the value of the 'Participant Associations' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.ParticipantAssociation}.
	 * 
	 * 
	 * @return the value of the 'Participant Associations' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_ParticipantAssociations()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='participantAssociation' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getParticipantAssociations();

	/**
	 * Returns the value of the 'Message Flow Associations' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.MessageFlowAssociation}.
	 * 
	 * 
	 * @return the value of the 'Message Flow Associations' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_MessageFlowAssociations()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='messageFlowAssociation' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getMessageFlowAssociations();

	/**
	 * 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#getCollaboration_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 'Choreography Ref' reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.Choreography}.
	 * 
	 * 
	 * @return the value of the 'Choreography Ref' reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_ChoreographyRef()
	 * @model ordered="false"
	 *        extendedMetaData="kind='element' name='choreographyRef' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getChoreographyRef();

	/**
	 * Returns the value of the 'Conversation Links' containment reference list.
	 * The list contents are of type {@link org.eclipse.bpmn2.ConversationLink}.
	 * 
	 * 
	 * @return the value of the 'Conversation Links' containment reference list.
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_ConversationLinks()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='conversationLink' namespace='http://www.omg.org/spec/BPMN/20100524/MODEL'"
	 * @generated
	 */
	EList getConversationLinks();

	/**
	 * Returns the value of the 'Is Closed' attribute.
	 * 
	 * 
	 * @return the value of the 'Is Closed' attribute.
	 * @see #setIsClosed(boolean)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_IsClosed()
	 * @model required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='isClosed'"
	 * @generated
	 */
	boolean isIsClosed();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.Collaboration#isIsClosed Is Closed}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Closed' attribute.
	 * @see #isIsClosed()
	 * @generated
	 */
	void setIsClosed(boolean value);

	/**
	 * Returns the value of the 'Name' attribute.
	 * 
	 * 
	 * @return the value of the 'Name' attribute.
	 * @see #setName(String)
	 * @see org.eclipse.bpmn2.Bpmn2Package#getCollaboration_Name()
	 * @model required="true" ordered="false"
	 *        extendedMetaData="kind='attribute' name='name'"
	 * @generated
	 */
	String getName();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.Collaboration#getName Name}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Name' attribute.
	 * @see #getName()
	 * @generated
	 */
	void setName(String value);

} // Collaboration