org.eclipse.bpmn2.di.BPMNShape 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.di;

import org.eclipse.bpmn2.BaseElement;

import org.eclipse.dd.di.LabeledShape;

/**
 * 
 * A representation of the model object 'BPMN Shape'.
 * 
 *
 * 
 * The following features are supported:
 * 
 * 
 *   {@link org.eclipse.bpmn2.di.BPMNShape#getLabel Label}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#getBpmnElement Bpmn Element}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#getChoreographyActivityShape Choreography Activity Shape}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#isIsExpanded Is Expanded}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#isIsHorizontal Is Horizontal}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#isIsMarkerVisible Is Marker Visible}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#isIsMessageVisible Is Message Visible}
 *   {@link org.eclipse.bpmn2.di.BPMNShape#getParticipantBandKind Participant Band Kind}
 * 
 *
 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape()
 * @model extendedMetaData="name='BPMNShape' kind='elementOnly'"
 * @generated
 */
public interface BPMNShape extends LabeledShape {
	/**
	 * Returns the value of the 'Label' containment reference.
	 * 
	 * 
	 * @return the value of the 'Label' containment reference.
	 * @see #setLabel(BPMNLabel)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_Label()
	 * @model containment="true" ordered="false"
	 *        extendedMetaData="kind='element' name='BPMNLabel' namespace='http://www.omg.org/spec/BPMN/20100524/DI'"
	 * @generated
	 */
	BPMNLabel getLabel();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#getLabel Label}' containment reference.
	 * 
	 * 
	 * @param value the new value of the 'Label' containment reference.
	 * @see #getLabel()
	 * @generated
	 */
	void setLabel(BPMNLabel value);

	/**
	 * Returns the value of the 'Bpmn Element' reference.
	 * 
	 * 
	 * @return the value of the 'Bpmn Element' reference.
	 * @see #setBpmnElement(BaseElement)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_BpmnElement()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='bpmnElement'"
	 * @generated
	 */
	BaseElement getBpmnElement();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#getBpmnElement Bpmn Element}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Bpmn Element' reference.
	 * @see #getBpmnElement()
	 * @generated
	 */
	void setBpmnElement(BaseElement value);

	/**
	 * Returns the value of the 'Choreography Activity Shape' reference.
	 * 
	 * 
	 * @return the value of the 'Choreography Activity Shape' reference.
	 * @see #setChoreographyActivityShape(BPMNShape)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_ChoreographyActivityShape()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='choreographyActivityShape'"
	 * @generated
	 */
	BPMNShape getChoreographyActivityShape();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#getChoreographyActivityShape Choreography Activity Shape}' reference.
	 * 
	 * 
	 * @param value the new value of the 'Choreography Activity Shape' reference.
	 * @see #getChoreographyActivityShape()
	 * @generated
	 */
	void setChoreographyActivityShape(BPMNShape value);

	/**
	 * Returns the value of the 'Is Expanded' attribute.
	 * 
	 * 
	 * @return the value of the 'Is Expanded' attribute.
	 * @see #setIsExpanded(boolean)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_IsExpanded()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='isExpanded'"
	 * @generated
	 */
	boolean isIsExpanded();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#isIsExpanded Is Expanded}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Expanded' attribute.
	 * @see #isIsExpanded()
	 * @generated
	 */
	void setIsExpanded(boolean value);

	/**
	 * Returns the value of the 'Is Horizontal' attribute.
	 * 
	 * 
	 * @return the value of the 'Is Horizontal' attribute.
	 * @see #setIsHorizontal(boolean)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_IsHorizontal()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='isHorizontal'"
	 * @generated
	 */
	boolean isIsHorizontal();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#isIsHorizontal Is Horizontal}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Horizontal' attribute.
	 * @see #isIsHorizontal()
	 * @generated
	 */
	void setIsHorizontal(boolean value);

	/**
	 * Returns the value of the 'Is Marker Visible' attribute.
	 * 
	 * 
	 * @return the value of the 'Is Marker Visible' attribute.
	 * @see #setIsMarkerVisible(boolean)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_IsMarkerVisible()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='isMarkerVisible'"
	 * @generated
	 */
	boolean isIsMarkerVisible();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#isIsMarkerVisible Is Marker Visible}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Marker Visible' attribute.
	 * @see #isIsMarkerVisible()
	 * @generated
	 */
	void setIsMarkerVisible(boolean value);

	/**
	 * Returns the value of the 'Is Message Visible' attribute.
	 * 
	 * 
	 * @return the value of the 'Is Message Visible' attribute.
	 * @see #setIsMessageVisible(boolean)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_IsMessageVisible()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='isMessageVisible'"
	 * @generated
	 */
	boolean isIsMessageVisible();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#isIsMessageVisible Is Message Visible}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Is Message Visible' attribute.
	 * @see #isIsMessageVisible()
	 * @generated
	 */
	void setIsMessageVisible(boolean value);

	/**
	 * Returns the value of the 'Participant Band Kind' attribute.
	 * The literals are from the enumeration {@link org.eclipse.bpmn2.di.ParticipantBandKind}.
	 * 
	 * 
	 * @return the value of the 'Participant Band Kind' attribute.
	 * @see org.eclipse.bpmn2.di.ParticipantBandKind
	 * @see #setParticipantBandKind(ParticipantBandKind)
	 * @see org.eclipse.bpmn2.di.BpmnDiPackage#getBPMNShape_ParticipantBandKind()
	 * @model ordered="false"
	 *        extendedMetaData="kind='attribute' name='participantBandKind'"
	 * @generated
	 */
	ParticipantBandKind getParticipantBandKind();

	/**
	 * Sets the value of the '{@link org.eclipse.bpmn2.di.BPMNShape#getParticipantBandKind Participant Band Kind}' attribute.
	 * 
	 * 
	 * @param value the new value of the 'Participant Band Kind' attribute.
	 * @see org.eclipse.bpmn2.di.ParticipantBandKind
	 * @see #getParticipantBandKind()
	 * @generated
	 */
	void setParticipantBandKind(ParticipantBandKind value);

} // BPMNShape