/*
 * The MIT License
 *
 * Copyright (c) 2004-2009, Sun Microsystems, Inc., Kohsuke Kawaguchi
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package hudson;

import java.util.Calendar;

/**
 * Provides a RSS feed view of the data.
 *
 * <p>
 * This interface allows data structure of any form to be exposed
 * as RSS feeds, just by writing a stateless singleton adapter code that
 * implements this interface.
 *
 * @author Kohsuke Kawaguchi
 */
public interface FeedAdapter<E> {
    /**
     * Gets the human readable title of the entry.
     * In RSS readers, this is usually displayed like an e-mail subject.
     */
    String getEntryTitle(E entry);

    /**
     * Gets the URL that represents this entry.
     * Relative to context root of the Hudson.
     */
    String getEntryUrl(E entry);

    /**
     * Unique ID of each entry.
     * RSS readers use this to determine what feeds are new and what are not.
     *
     * This needs to produce a tag URL as per RFC 4151, required by Atom 1.0.
     */
    String getEntryID(E entry);

    /**
     * (Potentially lengthy) plain text to be attached to the feed.
     * Can be null.
     */
    String getEntryDescription(E entry);

    /**
     * Timestamp of the last change in this entry.
     */
    Calendar getEntryTimestamp(E entry);

    /**
     * Author of this entry.
     */
    String getEntryAuthor(E entry);
}
