Link.java :  » Workflow-Engines » syrup » org » syrup » Java Open Source

package org.syrup;

/**
 * Links an InPort <i>from</i> one Task <i>to</i> an OutPort of another Task.
 * 
 * @author Robbert van Dalen
 */

public interface Link
{
    static final String COPYRIGHT = "Copyright 2005 Robbert van Dalen."
        + "At your option, you may copy, distribute, or make derivative works under "
        + "the terms of The Artistic License. This License may be found at "
        + "http://www.opensource.org/licenses/artistic-license.php. "
        + "THERE IS NO WARRANTY; USE THIS PRODUCT AT YOUR OWN RISK.";

    /**
     * Returns the OutPort of the Link. May return null to indicate a start
     * point.
     * 
     * @return The Link's OutPort.
     */
    public OutPort from();

    /**
     * Returns the InPort of the Link. May return null to indicate an end point.
     * 
     * @return The Link's InPort.
     */
    public InPort to();

    /**
     * Returns the content held by the Link.
     * 
     * @return The Link's Content.
     */
    public Data content();
}