org.sakaiproject.news.api

Interface NewsChannel

public interface NewsChannel

NewsChannel is the interface for a Sakai News service News channel. Messages in the NewsChannel are NewsItems.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewsitem(NewsItem item)
int	compareTo(Object obj) Checks the relative ordering of the String url's of two Channels.
boolean	equals(Object obj) Checks whether the parameter obj refers to the same channel as "this" channel.
String	getCopyright()
String	getDescription()
String	getLanguage()
String	getLastbuilddate()
Date	getLastbuilddateInDateFormat()
String	getLink()
List	getNewsitems() Accesses a list of all news items from this rss news feed.
List	getNewsitems(org.sakaiproject.javax.Filter filter) Accesses a filtered list of news items from this rss news feed.
String	getPubdate()
Date	getPubdateInDateFormat()
String	getSource()
String	getTitle()
int	hashCode() Calculates a hash code for the channel object's URL.
boolean	isUpdateAvailable() Checks whether an update is available for the rss news feed.
void	setCopyright(String copyright)
void	setDescription(String description)
void	setLanguage(String language)
void	setLastbuilddate(String builddate)
void	setLink(String link)
void	setNewsitems(List items)
void	setPubdate(String pubdate)
void	setSource(String source)
void	setTitle(String set)

Method Detail

getNewsitems

List getNewsitems()

Accesses a list of all news items from this rss news feed.

Returns:

a list of NewsItem objects (may be empty).

getNewsitems

List getNewsitems(org.sakaiproject.javax.Filter filter)

Accesses a filtered list of news items from this rss news feed.

Parameters:

filter - A filtering object to accept messages, or null if no filtering is desired.

Returns:

a list of NewsItem objects (may be empty).

getLink

String getLink()

getSource

String getSource()

getTitle

String getTitle()

getDescription

String getDescription()

getLanguage

String getLanguage()

getCopyright

String getCopyright()

getPubdate

String getPubdate()

getPubdateInDateFormat

Date getPubdateInDateFormat()

getLastbuilddate

String getLastbuilddate()

getLastbuilddateInDateFormat

Date getLastbuilddateInDateFormat()

setNewsitems

void setNewsitems(List items)

addNewsitem

void addNewsitem(NewsItem item)

setLink

void setLink(String link)

setSource

void setSource(String source)
               throws NewsConnectionException,
                      NewsFormatException

Throws:

NewsConnectionException

NewsFormatException

setTitle

void setTitle(String set)

setDescription

void setDescription(String description)

setLanguage

void setLanguage(String language)

setCopyright

void setCopyright(String copyright)

setPubdate

void setPubdate(String pubdate)

setLastbuilddate

void setLastbuilddate(String builddate)

isUpdateAvailable

boolean isUpdateAvailable()

Checks whether an update is available for the rss news feed.

Returns:

true if update is available, false otherwise

compareTo

int compareTo(Object obj)
              throws ClassCastException

Checks the relative ordering of the String url's of two Channels. Same response pattern as compareTo method for Strings--negative if "this" object is greater than parameter, zero if the objects are equal, and positive if "this" object is less than the parameter. The parameter can be a String reference or a MessageChannel object (otherwise method throws ClassCastException).

Returns:

A negative integer if "this" object is greater than parameter, zero if the objects are equal, and a positive integer if "this" object is less than the parameter

Throws:

ClassCastException

equals

boolean equals(Object obj)
               throws ClassCastException

Checks whether the parameter obj refers to the same channel as "this" channel. The parameter can be a String URL or a NewsChannel object (otherwise method throws ClassCastException).

Overrides:

equals in class Object

Returns:

true if the channels are the same, false otherwise

Throws:

ClassCastException

hashCode

int hashCode()

Calculates a hash code for the channel object's URL.

Overrides:

hashCode in class Object

Returns:

The hash-code for the String URL to the channel.