Package org.jasig.portlet.newsreader

Class PredefinedNewsConfiguration

java.lang.Object

org.jasig.portlet.newsreader.NewsConfiguration

org.jasig.portlet.newsreader.PredefinedNewsConfiguration

All Implemented Interfaces:

Comparable<NewsConfiguration>

public class PredefinedNewsConfiguration
extends NewsConfiguration

PredefinedNewsConfiguration represents a user configuration of a built-in news definition. There may be many configurations for each predefined news definition. This class defines an extra place to put user-specific configuration information and preferences.

Since:

5.1.1

Author:

Anthony Colebourne, Jen Bourey

Constructor Summary

Constructors

Constructor	Description
PredefinedNewsConfiguration()	Default constructor

Method Summary

Modifier and Type	Method	Description
void	addPreference(String name, String value)	Add a user preference for this configuration.
Map<String,String>	getPreferences()	Get the user-specific preferences for this configuration.
void	setPreferences(Map<String,String> preferences)	Set the user-specific preferences for this configuration.

Methods inherited from class org.jasig.portlet.newsreader.NewsConfiguration

compareTo, getId, getNewsDefinition, getNewsSet, isActive, isDisplayed, setActive, setDisplayed, setId, setNewsDefinition, setNewsSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PredefinedNewsConfiguration

public PredefinedNewsConfiguration()

Default constructor

Method Details

getPreferences

public Map<String,String> getPreferences()

Get the user-specific preferences for this configuration.

Returns:

a Map object

setPreferences

public void setPreferences(Map<String,String> preferences)

Set the user-specific preferences for this configuration.

Parameters:

preferences - a Map object

addPreference

public void addPreference(String name,
 String value)

Add a user preference for this configuration.

Parameters:

name - parameter name (key)

value - value to be stored