001/*
002 * #%L
003 * Netarchivesuite - harvester
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023package dk.netarkivet.harvester.harvesting.frontier;
024
025/**
026 * Common interface for an Heritrix frontier report wrapper.
027 */
028public interface FrontierReport {
029
030    /**
031     * @return the jobName
032     */
033    String getJobName();
034
035    /**
036     * @return the creation timestamp
037     */
038    long getTimestamp();
039
040    /**
041     * Add a line to the report.
042     *
043     * @param line line to add.
044     */
045    void addLine(FrontierReportLine line);
046
047    /**
048     * Returns the line of the frontier report corresponding to the queue for the given domain name.
049     *
050     * @param domainName the domain name.
051     * @return null if no queue for this domain name exists, otherwise the line of the frontier report corresponding to
052     * the queue for the given domain name.
053     */
054    FrontierReportLine getLineForDomain(String domainName);
055
056}