Package org.jasig.portlet.newsreader.adapter

Interface INewsAdapter

All Known Implementing Classes:

AbstractNewsAdapter, RomeAdapter, RomeAdapterFullStory

public interface INewsAdapter

INewsAdapter interface.

Since:

5.1.1

Author:

Anthony Colebourne

Method Summary

Modifier and Type	Method	Description
String	getClassName()	Provides the fully-qualified name of the concrete INewsAdapter class, which is used in creating a NewsDefinition.
String	getDescriptionKey()	Provides the key string for accessing the description of this adapter from the messageBundle bean.
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)	getSyndFeed.

Method Details

getClassName

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

String getNameKey()

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

Returns:

key string for this adaptor

getDescriptionKey

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

getSyndFeed.

Parameters:

config - a NewsConfiguration object

page - a int

maxStories - a int

Returns:

a PaginatingNewsFeed object

Throws:

NewsException - if any.