INewsItem.cs :  » Network-Clients » iReaper » NewsComponents » C# / CSharp Open Source

#region CVS Version Header
/*
 * $Id: INewsItem.cs,v 1.1 2006/09/27 03:37:01 cvsuser Exp $
 * Last modified by $Author: cvsuser $
 * Last modified at $Date: 2006/09/27 03:37:01 $
 * $Revision: 1.1 $
 */
#endregion

using System;
using System.Collections;
using System.Xml.XPath;

namespace NewsComponents{

  public interface INewsItem : ICloneable, IXPathNavigable
  {
    /// <summary>
    /// Gets the feed link (source the feed is requested from) the item belongs to.
    /// </summary>
    string FeedLink { get; }

    /// <summary>
    /// The link to the item.
    /// </summary>
    string Link { get; }

    /// <summary>
    /// The date the article or blog entry was made. 
    /// </summary>
    DateTime Date { get; }

    /// <summary>
    /// The unique identifier.
    /// </summary>
    string Id { get; }

    /// <summary>
    /// The unique identifier of the parent.
    /// </summary>
    string ParentId { get; }

    /// <summary>
    /// The content of the article or blog entry. 
    /// </summary>
    string Content { get; }

    /// <summary>
    /// Returns true, if Content contains something; else false.
    /// </summary>
    /// <remarks>Should be used instead of testing 
    /// (Content != null && Content.Length > 0) and is equivalent to 
    /// .ContentType == ContentType.None
    /// </remarks>
    bool HasContent { get; }

    /// <summary>
    /// Set new content of the article or blog entry.
    /// </summary>
    /// <param name="newContent">string</param>
    /// <param name="contentType">ContentType</param>
    void SetContent(string newContent, ContentType contentType) ;

    /// <summary>
    /// Indicates whether the description on this feed is text, HTML or XHTML. 
    /// </summary>
    ContentType ContentType { get; set; }

    /// <summary>
    /// Indicates whether the story has been read or not. 
    /// </summary>
    bool BeenRead { get; set; }

    /// <summary>
    /// Returns an object implementing the FeedDetails interface to which this item belongs
    /// </summary>
    IFeedDetails FeedDetails { get; set; }

    /// <summary>
    /// The author of the article or blog entry 
    /// </summary>
    string Author { get; set; }

    /// <summary>
    /// The title of the article or blog entry. 
    /// </summary>
    string Title { get; }

    /// <summary>
    /// The subject of the article or blog entry. 
    /// </summary>
    string Subject { get; }

    /// <summary>
    /// Returns the amount of comments attached.
    /// </summary>
    int CommentCount { get; set; }

    /// <summary>the URL to post comments to</summary>
    string CommentUrl { get; }

    /// <summary>the URL to get an RSS feed of comments from</summary>
    string CommentRssUrl { get; }

    /// <summary>
    /// Container for all the optional RSS elements for an item. Also 
    /// holds information from RSS modules. The keys in the hashtable 
    /// are instances of XmlQualifiedName while the values are instances 
    /// of XmlNode. 
    /// </summary>
    /// <remarks>Setting this field may have the side effect of setting certain read-only 
    /// properties such as CommentUrl and CommentStyle depending on whether CommentAPI 
    /// elements are contained in the table.</remarks>
    Hashtable OptionalElements { get; set; }

    /// <summary>
    /// Converts the object to an XML string containing an RSS 2.0 item.  
    /// </summary>
    /// <returns></returns>
    String ToString();

    /// <summary>
    /// Get the hash code of the object
    /// </summary>
    /// <returns></returns>
    int GetHashCode();

    /// <summary>
    /// Compares to see if two NewsItems are identical. Identity just checks to see if they have 
    /// the same link, if both have no link then checks to see if they have the same description
    /// </summary>
    /// <param name="obj"></param>
    /// <returns></returns>
    bool Equals(object obj);

  }

}