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 */
023
024package dk.netarkivet.viewerproxy;
025
026import java.net.URI;
027import java.util.Locale;
028import java.util.Set;
029
030/**
031 * The API for controlling the viewerproxy.
032 */
033public interface Controller {
034    /** Start URI collection. */
035    void startRecordingURIs();
036
037    /** Stop URI collection. */
038    void stopRecordingURIs();
039
040    /** Clear collected URIs. */
041    void clearRecordedURIs();
042
043    /**
044     * Get collected URIs.
045     *
046     * @return The collected URIs.
047     */
048    Set<URI> getRecordedURIs();
049
050    /**
051     * Change current index to work on these jobs.
052     *
053     * @param jobList The list of jobs.
054     * @param label A label this index should be known as
055     */
056    void changeIndex(Set<Long> jobList, String label);
057
058    /**
059     * Get current status of viewerproxy. The status is not supposed to be machine parsable. Do not base anything on the
060     * content of this status message, the format may change without notice.
061     *
062     * @param locale Indication of which locale to use for generating the string.
063     * @return A human-readable string with current status of the viewerproxy.
064     */
065    String getStatus(Locale locale);
066}