org.jasig.portlet.newsreader.dao

Interface NewsStore

All Known Implementing Classes:

HibernateNewsStore

public interface NewsStore

NewsStore provides a data store for news listings and configurations.

Author:

Anthony Colebourne, Jen Bourey

Method Summary

Modifier and Type	Method and Description
void	deleteNewsConfiguration(NewsConfiguration configuration) Remove a news configuration from the data store
void	deleteNewsDefinition(PredefinedNewsDefinition definition) Remove a news definition from the data store.
java.util.List<PredefinedNewsDefinition>	getHiddenPredefinedNewsDefinitions(java.lang.Long setId, java.util.Set<java.lang.String> role) Retrieve a list of hidden predefined newss for this portlet subscription and role.
NewsConfiguration	getNewsConfiguration(java.lang.Long id) Retrieve a news configuration.
java.util.List<NewsConfiguration>	getNewsConfigurations(java.lang.String subscribeId) Retrieve a list of news configurations for the specified portlet.
NewsDefinition	getNewsDefinition(java.lang.Long id) Retrieve a news definition.
NewsSet	getNewsSet(java.lang.Long id)
NewsSet	getNewsSet(java.lang.String userId, java.lang.String setName)
java.util.List<NewsSet>	getNewsSetsForUser(java.lang.String userId)
java.util.List<PredefinedNewsConfiguration>	getPredefinedNewsConfigurations() Retrieve a list of all pre-defined news configurations.
java.util.List<PredefinedNewsConfiguration>	getPredefinedNewsConfigurations(java.lang.Long setId, boolean visibleOnly) Retrieve a list of pre-defined news configurations for the specified portlet.
PredefinedNewsDefinition	getPredefinedNewsDefinition(java.lang.Long id) Retrieve a pre-defined news definition
PredefinedNewsDefinition	getPredefinedNewsDefinitionByName(java.lang.String fname)
java.util.List<UserDefinedNewsConfiguration>	getUserDefinedNewsConfigurations(java.lang.Long setId, boolean visibleOnly) Retrieve a list of user-defined news configurations for the specified portlet.
java.util.List<java.lang.String>	getUserRoles() Get a list of all user roles currently in use.
void	initNews(NewsSet set, java.util.Set<java.lang.String> roles) Initialize news subscriptions for a given portlet subscription and role.
void	storeNewsConfiguration(NewsConfiguration configuration) Save or update a news configuration.
void	storeNewsDefinition(NewsDefinition definition) Save or update a news definition.
void	storeNewsSet(NewsSet set)

Method Detail

getNewsSet

NewsSet getNewsSet(java.lang.Long id)

getNewsSet

NewsSet getNewsSet(java.lang.String userId,
                   java.lang.String setName)

getNewsSetsForUser

java.util.List<NewsSet> getNewsSetsForUser(java.lang.String userId)

storeNewsSet

void storeNewsSet(NewsSet set)

storeNewsDefinition

void storeNewsDefinition(NewsDefinition definition)

Save or update a news definition.

Parameters:

definition - NewsDefinition to be persisted

getNewsDefinition

NewsDefinition getNewsDefinition(java.lang.Long id)

Retrieve a news definition.

Parameters:

id - ID of the news definition to be retrieved

Returns:

getPredefinedNewsDefinition

PredefinedNewsDefinition getPredefinedNewsDefinition(java.lang.Long id)

Retrieve a pre-defined news definition

Parameters:

id - ID of the news definition to be retrieved

Returns:

getPredefinedNewsDefinitionByName

PredefinedNewsDefinition getPredefinedNewsDefinitionByName(java.lang.String fname)

storeNewsConfiguration

void storeNewsConfiguration(NewsConfiguration configuration)

Save or update a news configuration.

Parameters:

configuration - NewsConfiguration to be persisted

getNewsConfiguration

NewsConfiguration getNewsConfiguration(java.lang.Long id)

Retrieve a news configuration.

Parameters:

id - ID of the news configuration to be retrieved

Returns:

getNewsConfigurations

java.util.List<NewsConfiguration> getNewsConfigurations(java.lang.String subscribeId)

Retrieve a list of news configurations for the specified portlet.

Parameters:

subscribeId - unique ID for this portlet subscription

Returns:

getUserDefinedNewsConfigurations

java.util.List<UserDefinedNewsConfiguration> getUserDefinedNewsConfigurations(java.lang.Long setId,
                                                                              boolean visibleOnly)

Retrieve a list of user-defined news configurations for the specified portlet.

Parameters:

setId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden news configurations, false otherwise

Returns:

getPredefinedNewsConfigurations

java.util.List<PredefinedNewsConfiguration> getPredefinedNewsConfigurations(java.lang.Long setId,
                                                                            boolean visibleOnly)

Retrieve a list of pre-defined news configurations for the specified portlet.

Parameters:

setId - unique ID for this portlet subscription

visibleOnly - true to retrieve only non-hidden news configurations, false otherwise

Returns:

getPredefinedNewsConfigurations

java.util.List<PredefinedNewsConfiguration> getPredefinedNewsConfigurations()

Retrieve a list of all pre-defined news configurations.

Returns:

deleteNewsConfiguration

void deleteNewsConfiguration(NewsConfiguration configuration)

Remove a news configuration from the data store

Parameters:

configuration - configuration to be removed

deleteNewsDefinition

void deleteNewsDefinition(PredefinedNewsDefinition definition)

Remove a news definition from the data store.

Parameters:

definition - definition to be removed

initNews

void initNews(NewsSet set,
              java.util.Set<java.lang.String> roles)

Initialize news subscriptions for a given portlet subscription and role.

Parameters:

set - news collection to initialize

roles - user roles to use to find default newss

getHiddenPredefinedNewsDefinitions

java.util.List<PredefinedNewsDefinition> getHiddenPredefinedNewsDefinitions(java.lang.Long setId,
                                                                            java.util.Set<java.lang.String> role)

Retrieve a list of hidden predefined newss for this portlet subscription and role.

Parameters:

setId - unique ID for this portlet subscription

role - user role to use to find default newss

Returns:

getUserRoles

java.util.List<java.lang.String> getUserRoles()

Get a list of all user roles currently in use.

Returns: