org.jasig.portlet.newsreader.adapter

Interface INewsAdapter

All Known Implementing Classes:

AbstractNewsAdapter, RomeAdapter, RomeAdapterFullStory

public interface INewsAdapter

Author:

Anthony Colebourne

Method Summary

Modifier and Type	Method and Description
java.lang.String	getClassName() Provides the fully-qualified name of the concrete INewsAdapter class, which is used in creating a NewsDefinition.
java.lang.String	getDescriptionKey() Provides the key string for accessing the description of this adapter from the messageBundle bean.
java.lang.String	getNameKey() Provides the key string for accessing the name of this adapter from the messageBundle bean.
PaginatingNewsFeed	getSyndFeed(NewsConfiguration config, int page, int maxStories)

Method Detail

getClassName

java.lang.String getClassName()

Provides the fully-qualified name of the concrete INewsAdapter class, which is used in creating a NewsDefinition.

Returns:

concrete class name

See Also:

NewsDefinition

getNameKey

java.lang.String getNameKey()

Provides the key string for accessing the name of this adapter from the messageBundle bean.

Returns:

key string for this adaptor

getDescriptionKey

java.lang.String getDescriptionKey()

Provides the key string for accessing the description of this adapter from the messageBundle bean.

Returns:

description for this adaptor

getSyndFeed

PaginatingNewsFeed getSyndFeed(NewsConfiguration config,
                               int page,
                               int maxStories)
                        throws NewsException

Throws:

NewsException