org.jasig.portlet.newsreader
Class NewsDefinition

java.lang.Object
  org.jasig.portlet.newsreader.NewsDefinition

All Implemented Interfaces:

java.lang.Comparable<NewsDefinition>

Direct Known Subclasses:

PredefinedNewsDefinition, UserDefinedNewsDefinition

public class NewsDefinition
extends java.lang.Object
implements java.lang.Comparable<NewsDefinition>

NewsDefinition represents the base class for news registrations. Information required to retrieve the news, such as the news's URL or important default system-wide configuration information may be stored in the parameters map. In order to add this news for a specific user, a NewsConfiguration referencing this news definition must be created.

Author:

Anthony Colebourne, Jen Bourey

Constructor Summary

NewsDefinition()
Default constructor.

NewsDefinition(java.lang.Long id, java.lang.String className, java.lang.String name)

Method Summary

void	addParameter(java.lang.String name, java.lang.String value) Add an individual news parameter.
int	compareTo(NewsDefinition def)
java.lang.String	getClassName() Returns the name of the adapter class for this news which will determine how the news is retrieved.
java.lang.Long	getId() Return the unique id of this news.
java.lang.String	getName() Return the display name for this news.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Return the map of news parameters.
void	setClassName(java.lang.String className) Set the name of the adapter class for this news which will determine how the news is retrieved.
void	setId(java.lang.Long id) Set the unique id for this news.
void	setName(java.lang.String name) Set the display name for this news.
void	setParameters(java.util.Map<java.lang.String,java.lang.String> parameters) Set the map of news parameters.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NewsDefinition

public NewsDefinition()

Default constructor.

NewsDefinition

public NewsDefinition(java.lang.Long id,
                      java.lang.String className,
                      java.lang.String name)

Method Detail

getId

public java.lang.Long getId()

Return the unique id of this news.

Returns:

setId

public void setId(java.lang.Long id)

Set the unique id for this news.

Parameters:

id -

getClassName

public java.lang.String getClassName()

Returns the name of the adapter class for this news which will determine how the news is retrieved. This id must match a news adapter registered in the spring context files.

Returns:

setClassName

public void setClassName(java.lang.String className)

Set the name of the adapter class for this news which will determine how the news is retrieved. This id must match a news adapter registered in the spring context files.

Parameters:

className -

getName

public java.lang.String getName()

Return the display name for this news.

Returns:

setName

public void setName(java.lang.String name)

Set the display name for this news.

Parameters:

name -

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Return the map of news parameters. These parameters can hold any extra information needed by the particular adapter used by this news, such as a URL.

Returns:

parameter map

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String> parameters)

Set the map of news parameters. These parameters can hold any extra information needed by the particular adapter used by this news, such as a URL.

Parameters:

parameters - parameter map

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

Add an individual news parameter. These parameters can hold any extra information needed by the particular adapter used by this news, such as a URL.

Parameters:

name - parameter name (key)

value - value to be stored

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(NewsDefinition def)

Specified by:

compareTo in interface java.lang.Comparable<NewsDefinition>