This class is a bean to hold the settings for the RSS portlet.
This bean is prepared (populated) by an SettingsHandler
object, when it is set into the handler.
In addition to normal getters and setters,
this class contains a set of is*Set() methods. These are used
to determine if the value for the field has been set into this bean. This
information is used to determine if the value has changed, and should
therefore be persisted.
Method Summary
public int
getCacheTimeout() Get the cache timeout.
The cache timeout should be a positive number of seconds defining the
length in time that feed entries may be cached.
getMaxAge() Get the maximum feed entry age for display.
public int
getMaxDescriptionLength() Get the maximum description length.
This determines the number of characters that will be displayed for a
feed's description.
public int
getMaxEntries() Get the maximum entries that will be displayed.
getWindowTarget() Get the window target for feed links.
This has no respective setter, and is based on the return value
of isNewWindow().
public boolean
isDisableMaxAge() Is the maximum age restriction disabled?
If so, the display logic will ignore the maximum age setting
and display entries up to the number of maximum entries allowed.
Get the cache timeout.
The cache timeout should be a positive number of seconds defining the
length in time that feed entries may be cached. It may also be equal to
zero indicating that the feed entries should never be cached. If the
value is negative, the feed entries may be cached forever.
Get the size of the feeds set.
As opposed to calling getFeeds().size(), this is provided
for bean access within the display logic, as the Java
Collection.size() method is not bean-conforming.
This methos simply returns getFeeds().size().
Get the maximum feed entry age for display.
The display logic should not display any feed entries
that were published more than this number of hours
previous to now.
Get the maximum description length.
This determines the number of characters that will be displayed for a
feed's description. This is to prevent the portal display from being
adversely affected in the case where the feed entries contain
a very long description.
Get the window target for feed links.
This has no respective setter, and is based on the return value
of isNewWindow(). If said method returns true,
this method returns the string "_blank", else it returns "_top".
Is the maximum age restriction disabled?
If so, the display logic will ignore the maximum age setting
and display entries up to the number of maximum entries allowed.