/*
 * The University of Wales, Cardiff Triana Project Software License (Based
 * on the Apache Software License Version 1.1)
 *
 * Copyright (c) 2007 University of Wales, Cardiff. All rights reserved.
 *
 * Redistribution and use of the software in source and binary forms, with
 * or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1.  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *
 * 2.  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *
 * 3. The end-user documentation included with the redistribution, if any,
 *    must include the following acknowledgment: "This product includes
 *    software developed by the University of Wales, Cardiff for the Triana
 *    Project (http://www.trianacode.org)." Alternately, this
 *    acknowledgment may appear in the software itself, if and wherever
 *    such third-party acknowledgments normally appear.
 *
 * 4. The names "Triana" and "University of Wales, Cardiff" must not be
 *    used to endorse or promote products derived from this software
 *    without prior written permission. For written permission, please
 *    contact triana@trianacode.org.
 *
 * 5. Products derived from this software may not be called "Triana," nor
 *    may Triana appear in their name, without prior written permission of
 *    the University of Wales, Cardiff.
 *
 * 6. This software may not be sold, used or incorporated into any product
 *    for sale to third parties.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
 * NO EVENT SHALL UNIVERSITY OF WALES, CARDIFF OR ITS CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * ------------------------------------------------------------------------
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Triana Project. For more information on the
 * Triana Project, please see. http://www.trianacode.org.
 *
 * This license is based on the BSD license as adopted by the Apache
 * Foundation and is governed by the laws of England and Wales.
 *
 */
package org.trianacode.taskgraph;

import org.trianacode.taskgraph.event.CableListener;

/**
 * @author Ian
 * @version $Revision: 4048 $
 */
public interface Cable {
    String CONTROL_CABLE_TYPE = "control";

    /**
     * Adds a cable listener to this cable.
     */
    public void addCableListener(CableListener listener);

    /**
     * Removes a cable listener from this cable.
     */
    public void removeCableListener(CableListener listener);


    /**
     * @return the type of the cable
     */
    public String getType();


    /**
     * @return true is this cable is connected.
     */
    public boolean isConnected();


    /**
     * @return the node which sends data along this cable
     */
    public Node getSendingNode();

    /**
     * @return the task which sends data (via a node) along this cable
     */
    public Task getSendingTask();

    /**
     * @return the node which receives data along this cable
     */
    public Node getReceivingNode();

    /**
     * @return the task which receives data (via a node) along this cable
     */
    public Task getReceivingTask();


    /**
     * @return true if the specified node sends data to or receives data from this cable
     */
    public boolean contains(Node node);

    /**
     * @return true if the specified task sends data to or receives data from this cable
     */
    public boolean connects(Task task);


    /**
     * Connect two nodes with this cable.
     */
    public void connect(Node sendnode, Node recnode) throws CableException;

    /**
     * Reconnects the cable to receive from/send to the specified node
     */
    public void reconnect(Node recnode) throws CableException;

    /**
     * Disconnect this cable from its nodes. Note that a disconnected cable cannot be reconnected.
     */
    public void disconnect() throws CableException;


}