| /* |
| * Copyright (c) 2005, 2006 IBM Corporation and others. |
| * 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: |
| * IBM - initial API and implementation |
| * |
| * $Id: TimeEvent.java,v 1.9 2006/05/26 16:34:02 khussey Exp $ |
| */ |
| package org.eclipse.uml2.uml; |
| |
| import java.util.Map; |
| |
| import org.eclipse.emf.common.util.DiagnosticChain; |
| |
| import org.eclipse.emf.ecore.EClass; |
| |
| /** |
| * <!-- begin-user-doc --> |
| * A representation of the model object '<em><b>Time Event</b></em>'. |
| * <!-- end-user-doc --> |
| * |
| * <!-- begin-model-doc --> |
| * A time event specifies a point in time. At the specified time, the event occurs. |
| * A time event can be defined relative to entering the current state of the executing state machine. |
| * <!-- end-model-doc --> |
| * |
| * <p> |
| * The following features are supported: |
| * <ul> |
| * <li>{@link org.eclipse.uml2.uml.TimeEvent#isRelative <em>Is Relative</em>}</li> |
| * <li>{@link org.eclipse.uml2.uml.TimeEvent#getWhen <em>When</em>}</li> |
| * </ul> |
| * </p> |
| * |
| * @see org.eclipse.uml2.uml.UMLPackage#getTimeEvent() |
| * @model |
| * @generated |
| */ |
| public interface TimeEvent |
| extends Event { |
| |
| /** |
| * Returns the value of the '<em><b>Is Relative</b></em>' attribute. |
| * The default value is <code>"false"</code>. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies whether it is relative or absolute time. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>Is Relative</em>' attribute. |
| * @see #setIsRelative(boolean) |
| * @see org.eclipse.uml2.uml.UMLPackage#getTimeEvent_IsRelative() |
| * @model default="false" dataType="org.eclipse.uml2.uml.Boolean" required="true" ordered="false" |
| * @generated |
| */ |
| boolean isRelative(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.TimeEvent#isRelative <em>Is Relative</em>}' attribute. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>Is Relative</em>' attribute. |
| * @see #isRelative() |
| * @generated |
| */ |
| void setIsRelative(boolean value); |
| |
| /** |
| * Returns the value of the '<em><b>When</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * Specifies the corresponding time deadline. |
| * <!-- end-model-doc --> |
| * @return the value of the '<em>When</em>' containment reference. |
| * @see #setWhen(ValueSpecification) |
| * @see org.eclipse.uml2.uml.UMLPackage#getTimeEvent_When() |
| * @model containment="true" resolveProxies="true" required="true" ordered="false" |
| * @generated |
| */ |
| ValueSpecification getWhen(); |
| |
| /** |
| * Sets the value of the '{@link org.eclipse.uml2.uml.TimeEvent#getWhen <em>When</em>}' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param value the new value of the '<em>When</em>' containment reference. |
| * @see #getWhen() |
| * @generated |
| */ |
| void setWhen(ValueSpecification value); |
| |
| /** |
| * Creates a new {@link org.eclipse.uml2.uml.ValueSpecification}, with the specified '<em><b>Name</b></em>', and '<em><b>Type</b></em>', and sets the '<em><b>When</b></em>' containment reference. |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * @param name The '<em><b>Name</b></em>' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or <code>null</code>. |
| * @param type The '<em><b>Type</b></em>' for the new {@link org.eclipse.uml2.uml.ValueSpecification}, or <code>null</code>. |
| * @param eClass The Ecore class of the {@link org.eclipse.uml2.uml.ValueSpecification} to create. |
| * @return The new {@link org.eclipse.uml2.uml.ValueSpecification}. |
| * @see #getWhen() |
| * @generated |
| */ |
| ValueSpecification createWhen(String name, Type type, EClass eClass); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The ValueSpecification when must return a non-negative Integer. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateWhenNonNegative(DiagnosticChain diagnostics, Map context); |
| |
| /** |
| * <!-- begin-user-doc --> |
| * <!-- end-user-doc --> |
| * <!-- begin-model-doc --> |
| * The starting time for a relative time event may only be omitted for a time event that is the trigger of a state machine. |
| * true |
| * <!-- end-model-doc --> |
| * @model |
| * @generated |
| */ |
| boolean validateStartingTime(DiagnosticChain diagnostics, Map context); |
| |
| } // TimeEvent |