DownloadScrapeResult.java

/*
 * File    : DownloadScrapeResult.java
 * Created : 12-Jan-2004
 * By      : parg
 * 
 * Azureus - a Java Bittorrent client
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details ( see the LICENSE file ).
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

package org.gudy.azureus2.plugins.download;

import java.net.URL;

/**
 * @author parg
 * This class represents the results of scrapes for the download
 */

import org.gudy.azureus2.plugins.download.Download;

public interface 
DownloadScrapeResult 
{
	public static final int	RT_SUCCESS	= 1;
	public static final int RT_ERROR	= 2;
	
	/**
	 * Gives access to the associated download
	 * @return
   *
   * @since 2.0.7.0
	 */
	public Download
	getDownload();
	
	/**
	 * A scrape result can denote either a successful or failed scrape.
	 * @return RT_SUCCESS or RT_ERROR
   *
   * @since 2.0.7.0
	 */
	public int
	getResponseType();	// either RT_SUCCESS or RT_ERROR
	
	/**
	 * Gives the number of seeds returned by the scrape
	 * @return
   *
   * @since 2.0.7.0
	 */
	public int
	getSeedCount();
	
	/**
	 * Gives the number of non-seeds returned by the scrape
	 * @return
   *
   * @since 2.0.7.0
	 */
	public int
	getNonSeedCount();

  /* Gives the next scrape time
   * @return time next scrape will start in milliseconds since epoch
   *
   * @since 2.0.8.0
   */
  public long
  getScrapeStartTime();

  /** Sets the next scrape time
   *
   * @param nextScrapeStartTime time to start in milliseconds since epoch
   *
   * @since 2.1.0.2
   */
  public void setNextScrapeStartTime(long nextScrapeStartTime);
  
  public long
  getNextScrapeStartTime();
  
  /**
   * returns a string representation of the scrape status
   * @return
   * @since 2.1.0.4
   */
  
  public String
  getStatus();
  
	/**
	 * The URL for the tracker
	 * @return
	 */

  public URL
  getURL();
}