org.jasig.portlet.newsreader
Class PredefinedNewsDefinition

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

All Implemented Interfaces:

java.lang.Comparable<NewsDefinition>

public class PredefinedNewsDefinition
extends NewsDefinition

PredefinedNewsDefinition represents a built-in news definition. These definitions are defined in the database by an administrator, and can be automatically added to user's news registration lists based on user role.

Author:

Anthony Colebourne, Jen Bourey

Constructor Summary

PredefinedNewsDefinition()
Default constructor

PredefinedNewsDefinition(java.lang.Long id, java.lang.String className, java.lang.String name)
Construct a new predefined news definition

Method Summary

void	addDefaultRole(java.lang.String role) Add a user role to the set of roles that should get this news by default.
void	addUserConfiguration(PredefinedNewsConfiguration config) Add a user configuration for this news definition
java.util.Set<java.lang.String>	getDefaultRoles() Get the set of user roles who should get this news by default.
java.util.Set<PredefinedNewsConfiguration>	getUserConfigurations() Get all the user configurations for this news definition
void	setDefaultRoles(java.util.Set<java.lang.String> defaultRoles) Set the user roles should should get this news by default.
void	setUserConfigurations(java.util.Set<PredefinedNewsConfiguration> configurations) Set the user configurations for this news definition

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

addParameter, compareTo, getClassName, getId, getName, getParameters, setClassName, setId, setName, setParameters, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PredefinedNewsDefinition

public PredefinedNewsDefinition()

Default constructor

PredefinedNewsDefinition

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

Construct a new predefined news definition

Parameters:

id -

className -

name -

Method Detail

getUserConfigurations

public java.util.Set<PredefinedNewsConfiguration> getUserConfigurations()

Get all the user configurations for this news definition

Returns:

setUserConfigurations

public void setUserConfigurations(java.util.Set<PredefinedNewsConfiguration> configurations)

Set the user configurations for this news definition

Parameters:

configurations -

getDefaultRoles

public java.util.Set<java.lang.String> getDefaultRoles()

Get the set of user roles who should get this news by default.

Returns:

set of default user roles

setDefaultRoles

public void setDefaultRoles(java.util.Set<java.lang.String> defaultRoles)

Set the user roles should should get this news by default.

Parameters:

defaultRoles - set of default user roles

addUserConfiguration

public void addUserConfiguration(PredefinedNewsConfiguration config)

Add a user configuration for this news definition

Parameters:

config -

addDefaultRole

public void addDefaultRole(java.lang.String role)

Add a user role to the set of roles that should get this news by default.

Parameters:

role - user role to be added