org.jasig.portlet.newsreader
Class PredefinedNewsConfiguration

java.lang.Object
  org.jasig.portlet.newsreader.NewsConfiguration
      org.jasig.portlet.newsreader.PredefinedNewsConfiguration

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.

Author:

Anthony Colebourne, Jen Bourey

Constructor Summary

PredefinedNewsConfiguration()
Default constructor

Method Summary

void	addPreference(String name, String value) Add a user preference for this configuration.
PredefinedNewsDefinition	getNewsDefinition() Get the NewsDefinition for the news being configured.
Map<String,String>	getPreferences() Get the user-specific preferences for this configuration.
void	setNewsDefinition(PredefinedNewsDefinition definition)
void	setPreferences(Map<String,String> preferences) Set the user-specific preferences for this configuration.

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

getId, 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 Detail

PredefinedNewsConfiguration

public PredefinedNewsConfiguration()

Default constructor

Method Detail

getPreferences

public Map<String,String> getPreferences()

Get the user-specific preferences for this configuration.

Returns:

setPreferences

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

Set the user-specific preferences for this configuration.

Parameters:

preferences -

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

getNewsDefinition

public PredefinedNewsDefinition getNewsDefinition()

Description copied from class: NewsConfiguration

Get the NewsDefinition for the news being configured.

Overrides:

getNewsDefinition in class NewsConfiguration

Returns:

setNewsDefinition

public void setNewsDefinition(PredefinedNewsDefinition definition)