001/* Interface for objects that support deferrable change requests.
002
003 Copyright (c) 2003-2013 The Regents of the University of California.
004 All rights reserved.
005 Permission is hereby granted, without written agreement and without
006 license or royalty fees, to use, copy, modify, and distribute this
007 software and its documentation for any purpose, provided that the above
008 copyright notice and the following two paragraphs appear in all copies
009 of this software.
010
011 IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
012 FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
013 ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
014 THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
015 SUCH DAMAGE.
016
017 THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
018 INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
019 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
020 PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
021 CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
022 ENHANCEMENTS, OR MODIFICATIONS.
023
024 PT_COPYRIGHT_VERSION_2
025 COPYRIGHTENDKEY
026 */
027package ptolemy.kernel.util;
028
029import ptolemy.kernel.ComponentPort;
030
031///////////////////////////////////////////////////////////////////
032//// Flowable
033
034/**
035 An interface for objects that have one port that serves as an input
036 and one that serves as an output. This interface in a convenience
037 so that graphical editors that don't care about specific ports
038 can nonetheless render flows through the component.
039
040 @author Edward A. Lee
041 @version $Id$
042 @since Ptolemy II 8.0
043 @Pt.ProposedRating Yellow (eal)
044 @Pt.AcceptedRating Red (neuendor)
045 @see ChangeRequest
046 */
047public interface Flowable {
048
049    ///////////////////////////////////////////////////////////////////
050    ////                         public methods                    ////
051
052    /** Return the incoming port.
053     *  @return The incoming port.
054     */
055    public ComponentPort getIncomingPort();
056
057    /** Return the outgoing port.
058     *  @return The outgoing port.
059     */
060    public ComponentPort getOutgoingPort();
061}