src/main/optional/mods/railcraft/api/tracks/IRoutingTrack.java

/*
 * Copyright (c) CovertJaguar, 2011 http://railcraft.info
 * 
 * This code is the property of CovertJaguar
 * and may only be used with explicit written
 * permission unless otherwise specified on the
 * license page at railcraft.wikispaces.com.
 */
package mods.railcraft.api.tracks;

/**
 * This interface provides a means for addons to hook into Routing Tracks and
 * change the ticket on the fly. Be warned, security is the responsibility of
 * the addon.
 *
 * @author CovertJaguar <http://www.ModTMechworks.info/>
 */
public interface IRoutingTrack {

    /**
     * This function will be used to construct a ticket item for the Routing
     * Track.
     *
     * @param dest The Destination routing String
     * @param title The title displayed to ticket holders
     * @param owner IMPORTANT: This must be not be user defined. It should be
     * locked to the user who placed the block/turtle/whatever that is trying to
     * set the ticket.
     * @return true if the setting succeeded
     */
    boolean setTicket(String dest, String title, String owner);

    /**
     * Wipes the existing ticket.
     */
    void clearTicket();

}