org.sakaiproject.news.api

Interface NewsService

All Superinterfaces:

org.sakaiproject.entity.api.EntityProducer

public interface NewsService
extends org.sakaiproject.entity.api.EntityProducer

NewsService is the interface for retrieving and caching news items from a rss news feed.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REFERENCE_ROOT This string starts the references to resources in this service.
static String	SERVICE_NAME This string can be used to find the service in the service manager.

Method Summary

Methods

Modifier and Type	Method and Description
NewsChannel	getChannel(String source) Retrieves a NewsChannel object indexed by a URL.
List	getNewsitems(String channel) Retrieves a list of items from an rss feed.
List	getNewsitems(String channel, org.sakaiproject.javax.Filter filter) Retrieves a list of items from an rss feed.
boolean	isUpdateAvailable(String channel) Checks whether an update is available for the rss news feed.
void	removeChannel(String channel) Retrieves a list of rss feeds that are being used.

Methods inherited from interface org.sakaiproject.entity.api.EntityProducer

archive, getEntity, getEntityAuthzGroups, getEntityDescription, getEntityResourceProperties, getEntityUrl, getHttpAccess, getLabel, merge, parseEntityReference, willArchiveMerge

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

This string can be used to find the service in the service manager.

REFERENCE_ROOT

static final String REFERENCE_ROOT

This string starts the references to resources in this service.

See Also:

Constant Field Values

Method Detail

getChannel

NewsChannel getChannel(String source)
                       throws NewsConnectionException,
                              NewsFormatException

Retrieves a NewsChannel object indexed by a URL.

Parameters:

source - The url for the channel.

Returns:

A NewsChannel object (possibly null).

Throws:

NewsConnectionException

NewsFormatException

removeChannel

void removeChannel(String channel)

Retrieves a list of rss feeds that are being used.

Throws:

? - if param channel is not a valid url.

getNewsitems

List getNewsitems(String channel)
                  throws NewsConnectionException,
                         NewsFormatException

Retrieves a list of items from an rss feed.

Parameters:

channel - The url for the feed.

Returns:

A list of NewsItem objects retrieved from the feed.

Throws:

? - if param feed is not a valid url.

NewsConnectionException

NewsFormatException

getNewsitems

List getNewsitems(String channel,
                org.sakaiproject.javax.Filter filter)
                  throws NewsConnectionException,
                         NewsFormatException

Retrieves a list of items from an rss feed.

Parameters:

channel - The url for the feed.

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

Returns:

A list of NewsItem objects retrieved from the feed.

Throws:

? - if param feed is not a valid url.

NewsConnectionException

NewsFormatException

isUpdateAvailable

boolean isUpdateAvailable(String channel)

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

Parameters:

feed - The url for the feed.

Returns:

true if update is available, false otherwise

Throws:

? - if param feed is not a valid url.