Package org.jasig.portlet.newsreader
Class NewsConfiguration
java.lang.Object
org.jasig.portlet.newsreader.NewsConfiguration
- All Implemented Interfaces:
Comparable<NewsConfiguration>
- Direct Known Subclasses:
PredefinedNewsConfiguration,UserDefinedNewsConfiguration
NewsConfiguration represents a user-specific registration and configuration
for a NewsDefinition.
- Since:
- 5.1.1
- Author:
- Anthony Colebourne, Jen Bourey
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintcompareTo(NewsConfiguration config) getId()Get the unique ID for this NewsConfiguration.Get the NewsDefinition for the news being configured.Getter for the fieldnewsSet.booleanisActive()Determine whether this feed is active.booleanDetermine whether this news should be displayed or hidden.voidsetActive(boolean active) Set whether this feed should be displayed or hidden.voidsetDisplayed(boolean displayed) Set whether this news should be displayed or hidden.voidSet the unique ID for this NewsConfiguration.voidsetNewsDefinition(NewsDefinition definition) Set the NewsDefinition for the news being configured.voidsetNewsSet(NewsSet newsSet) Setter for the fieldnewsSet.
-
Constructor Details
-
NewsConfiguration
public NewsConfiguration()
-
-
Method Details
-
isActive
public boolean isActive()Determine whether this feed is active.- Returns:
- a boolean
-
setActive
public void setActive(boolean active) Set whether this feed should be displayed or hidden.- Parameters:
active- a boolean
-
isDisplayed
public boolean isDisplayed()Determine whether this news should be displayed or hidden.- Returns:
- a boolean
-
setDisplayed
public void setDisplayed(boolean displayed) Set whether this news should be displayed or hidden.- Parameters:
displayed- a boolean
-
getId
Get the unique ID for this NewsConfiguration.- Returns:
- a
Longobject
-
setId
Set the unique ID for this NewsConfiguration.- Parameters:
id- aLongobject
-
getNewsDefinition
Get the NewsDefinition for the news being configured.- Returns:
- a
NewsDefinitionobject
-
setNewsDefinition
Set the NewsDefinition for the news being configured.- Parameters:
definition- aNewsDefinitionobject
-
getNewsSet
Getter for the field
newsSet.- Returns:
- a
NewsSetobject
-
setNewsSet
Setter for the field
newsSet.- Parameters:
newsSet- aNewsSetobject
-
compareTo
- Specified by:
compareToin interfaceComparable<NewsConfiguration>
-