org.eclipse.uml2.uml.EncapsulatedClassifier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of uml Show documentation
UML2 UML Model
There is a newer version: 5.0.0-v20140602-0749
/*
 * Copyright (c) 2005, 2011 IBM Corporation, CEA, 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
 *   Kenn Hussey (CEA) - 327039
 *
 * $Id: EncapsulatedClassifier.java,v 1.10 2007/10/23 15:54:22 jbruck Exp $
 */
package org.eclipse.uml2.uml;

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

/**
 * 
 * A representation of the model object 'Encapsulated Classifier'.
 * 
 *
 * 
 * A classifier has the ability to own ports as specific and type checked interaction points.
 * 
 *
 * 
 * The following features are supported:
 * 

 *   {@link org.eclipse.uml2.uml.EncapsulatedClassifier#getOwnedPorts Owned Port}
 * 
 * 
 *
 * @see org.eclipse.uml2.uml.UMLPackage#getEncapsulatedClassifier()
 * @model abstract="true"
 * @generated
 */
public interface EncapsulatedClassifier
		extends StructuredClassifier {

	/**
	 * Returns the value of the 'Owned Port' reference list.
	 * The list contents are of type {@link org.eclipse.uml2.uml.Port}.
	 * 
	 * This feature subsets the following features:
	 * 

	 *   '{@link org.eclipse.uml2.uml.StructuredClassifier#getOwnedAttributes() Owned Attribute}'
	 * 
	 * 
	 * 
	 * 
	 * 
	 * References a set of ports that an encapsulated classifier owns.
	 * 
	 * @return the value of the 'Owned Port' reference list.
	 * @see org.eclipse.uml2.uml.UMLPackage#getEncapsulatedClassifier_OwnedPort()
	 * @model transient="true" changeable="false" volatile="true" derived="true" ordered="false"
	 * @generated
	 */
	EList getOwnedPorts();

	/**
	 * Creates a new {@link org.eclipse.uml2.uml.Port}, with the specified 'Name', and 'Type', and appends it to the 'Owned Port' reference list.
	 * 
	 * 
	 * @param name The 'Name' for the new {@link org.eclipse.uml2.uml.Port}, or null.
	 * @param type The 'Type' for the new {@link org.eclipse.uml2.uml.Port}, or null.
	 * @return The new {@link org.eclipse.uml2.uml.Port}.
	 * @see #getOwnedPorts()
	 * @generated NOT
	 */
	Port createOwnedPort(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type' from the 'Owned Port' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @return The first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type', or null.
	 * @see #getOwnedPorts()
	 * @generated
	 */
	Port getOwnedPort(String name, Type type);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type' from the 'Owned Port' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	 * @return The first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type', or null.
	 * @see #getOwnedPorts()
	 * @generated
	 */
	Port getOwnedPort(String name, Type type, boolean ignoreCase);

	/**
	 * Retrieves the first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type' from the 'Owned Port' reference list.
	 * 
	 * 
	 * @param name The 'Name' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @param type The 'Type' of the {@link org.eclipse.uml2.uml.Port} to retrieve, or null.
	 * @param ignoreCase Whether to ignore case in {@link java.lang.String} comparisons.
	 * @param createOnDemand Whether to create a {@link org.eclipse.uml2.uml.Port} on demand if not found.
	 * @return The first {@link org.eclipse.uml2.uml.Port} with the specified 'Name', and 'Type', or null.
	 * @see #getOwnedPorts()
	 * @generated NOT
	 */
	Port getOwnedPort(String name, Type type, boolean ignoreCase,
			boolean createOnDemand);

} // EncapsulatedClassifier