org.jasig.portal
Interface IChannelRegistryStore

All Known Implementing Classes:

AbstractChannelRegistryStore, JpaChannelRegistryStore

Deprecated. IChannel rendering code will be replaced with portlet specific rendering code in a future release

@Deprecated
public interface IChannelRegistryStore

Interface defining how the portal reads and writes its channel types, definitions, and categories.

Version:

$Revision: 19776 $

Author:

Ken Weiner, kweiner@unicon.net

Method Summary

void	addCategoryToCategory(ChannelCategory source, ChannelCategory destination) Deprecated. Makes one category a child of another.
void	addChannelToCategory(IChannelDefinition channelDef, ChannelCategory category) Deprecated. Associates a channel definition with a category.
void	approveChannelDefinition(IChannelDefinition channelDef, IPerson approver, Date approveDate) Deprecated. Sets a channel definition as "approved".
void	deleteChannelCategory(ChannelCategory category) Deprecated. Deletes a channel category.
void	deleteChannelDefinition(IChannelDefinition channelDef) Deprecated. Permanently deletes a channel definition from the store.
void	deleteChannelType(IChannelType chanType) Deprecated. Deletes a channel type.
void	disapproveChannelDefinition(IChannelDefinition channelDef) Deprecated. Sets a channel definition as "unapproved".
ChannelCategory[]	getAllChildCategories(ChannelCategory parent) Deprecated. Recursively gets all child channel categories for a parent category.
IChannelDefinition[]	getAllChildChannels(ChannelCategory parent) Deprecated. Recursively gets all child channel definitions for a parent category.
IChannelDefinition[]	getAllChildChannels(ChannelCategory parent, IPerson person) Deprecated. Recursively gets all child channel definitions for a parent category that the given user is allowed to subscribe to.
IChannelDefinition[]	getAllManageableChildChannels(ChannelCategory parent, IPerson person) Deprecated. Recursively gets all child channel definitions for a parent category that the given user is allowed to manage.
ChannelCategory	getChannelCategory(String channelCategoryId) Deprecated. Gets an existing channel category.
IChannelDefinition	getChannelDefinition(int channelPublishId) Deprecated. Get a channel definition.
IChannelDefinition	getChannelDefinition(String channelFunctionalName) Deprecated. Get a channel definition.
IChannelDefinition	getChannelDefinitionByName(String channelName) Deprecated. Get a channel definition by name.
List<IChannelDefinition>	getChannelDefinitions() Deprecated. Get all channel definitions including ones that haven't been approved.
List<IChannelDefinition>	getChannelDefinitions(IPerson person) Deprecated. Get all channel definitions filtered by a user's channel permissions
IChannelType	getChannelType(int channelTypeId) Deprecated. Get the channel type associated with a particular identifier.
IChannelType	getChannelType(String name) Deprecated. Get the channel type associated with a particular identifier.
List<IChannelType>	getChannelTypes() Deprecated. Returns an array of ChannelTypes.
ChannelCategory[]	getChildCategories(ChannelCategory parent) Deprecated. Gets all child channel categories for a parent category.
IChannelDefinition[]	getChildChannels(ChannelCategory parent) Deprecated. Gets all child channel definitions for a parent category.
IChannelDefinition[]	getChildChannels(ChannelCategory parent, IPerson person) Deprecated. Gets all child channel definitions for a parent category that the given user is allowed to subscribe to.
IChannelDefinition[]	getManageableChildChannels(ChannelCategory parent, IPerson person) Deprecated. Gets all child channel definitions for a parent category that the given user is allowed to manage.
IChannelType	getOrCreateChannelType(String name, String clazz, String cpdUri) Deprecated. Convience for getChannelType(String) and newChannelType(String, String, String).
ChannelCategory[]	getParentCategories(ChannelCategory child) Deprecated. Gets the immediate parent categories of this category.
ChannelCategory[]	getParentCategories(IChannelDefinition child) Deprecated. Gets the immediate parent categories of this channel definition.
ChannelCategory	getTopLevelChannelCategory() Deprecated. Gets top level channel category
ChannelCategory	newChannelCategory() Deprecated. Creates a new channel category.
ChannelCategory	newChannelCategory(String name, String description, String creatorId) Deprecated. Creates a new channel category with the specified values.
IChannelDefinition	newChannelDefinition(int channelTypeId, String fname, String clazz, String name, String title) Deprecated. Create a new ChannelDefinition object.
IChannelType	newChannelType(String name, String clazz, String cpdUri) Deprecated. Creates a new channel type.
void	removeCategoryFromCategory(ChannelCategory child, ChannelCategory parent) Deprecated. Makes one category a child of another.
void	removeChannelFromCategory(IChannelDefinition channelDef, ChannelCategory category) Deprecated. Disassociates a channel definition from a category.
void	saveChannelCategory(ChannelCategory category) Deprecated. Persists a channel category.
void	saveChannelDefinition(IChannelDefinition channelDef) Deprecated. Persists a channel definition.
IChannelType	saveChannelType(IChannelType chanType) Deprecated. Persists a channel type.

Method Detail

newChannelType

IChannelType newChannelType(String name,
                            String clazz,
                            String cpdUri)

Deprecated.

Creates a new channel type.

Returns:

the new channel type

Throws:

Exception

getOrCreateChannelType

IChannelType getOrCreateChannelType(String name,
                                    String clazz,
                                    String cpdUri)

Deprecated.

Convience for getChannelType(String) and newChannelType(String, String, String). If the get returns null the type will be created and returned. If the get returns an IChannelType the clazz and cpdUri parameters are ignored

See Also:

getChannelType(String), newChannelType(String, String, String)

getChannelType

IChannelType getChannelType(int channelTypeId)

Deprecated.

Get the channel type associated with a particular identifier.

Parameters:

channelTypeId - the channel type identifier

Returns:

channelType the channel type

Throws:

Exception

getChannelType

IChannelType getChannelType(String name)

Deprecated.

Get the channel type associated with a particular identifier.

Parameters:

name - the channel type name

Returns:

channelType the channel type

Throws:

Exception

getChannelTypes

List<IChannelType> getChannelTypes()

Deprecated.

Returns an array of ChannelTypes.

Returns:

the list of publishable channel types

Throws:

Exception

saveChannelType

IChannelType saveChannelType(IChannelType chanType)

Deprecated.

Persists a channel type.

Parameters:

chanType - a channel type

Throws:

Exception

deleteChannelType

void deleteChannelType(IChannelType chanType)

Deprecated.

Deletes a channel type. The deletion will only succeed if no existing channels reference the channel type.

Parameters:

chanType - a channel type

Throws:

Exception

newChannelDefinition

IChannelDefinition newChannelDefinition(int channelTypeId,
                                        String fname,
                                        String clazz,
                                        String name,
                                        String title)

Deprecated.

Create a new ChannelDefinition object.

Returns:

the new channel definition

Throws:

Exception

getChannelDefinition

IChannelDefinition getChannelDefinition(int channelPublishId)

Deprecated.

Get a channel definition.

Parameters:

channelPublishId - a channel publish ID

Returns:

a definition of the channel or null if no matching channel definition can be found

Throws:

Exception

getChannelDefinition

IChannelDefinition getChannelDefinition(String channelFunctionalName)

Deprecated.

Get a channel definition. If there is more than one channel definition with the given functional name, then the first one will be returned.

Parameters:

channelFunctionalName - a channel functional name

Returns:

a definition of the channel or null if no matching channel definition can be found

Throws:

Exception

getChannelDefinitionByName

IChannelDefinition getChannelDefinitionByName(String channelName)

Deprecated.

Get a channel definition by name.

Parameters:

channelName - a channel name

Returns:

a definition of the channel or null if no matching channel definition can be found

getChannelDefinitions

List<IChannelDefinition> getChannelDefinitions()

Deprecated.

Get all channel definitions including ones that haven't been approved.

Returns:

channelDefs, the channel definitions

Throws:

Exception

getChannelDefinitions

List<IChannelDefinition> getChannelDefinitions(IPerson person)

Deprecated.

Get all channel definitions filtered by a user's channel permissions

Returns:

the filtered list of channel definitions

saveChannelDefinition

void saveChannelDefinition(IChannelDefinition channelDef)

Deprecated.

Persists a channel definition.

Parameters:

channelDef - the channel definition

Throws:

Exception

deleteChannelDefinition

void deleteChannelDefinition(IChannelDefinition channelDef)

Deprecated.

Permanently deletes a channel definition from the store.

Parameters:

channelDef - the channel definition

Throws:

Exception

approveChannelDefinition

void approveChannelDefinition(IChannelDefinition channelDef,
                              IPerson approver,
                              Date approveDate)

Deprecated.

Sets a channel definition as "approved". This effectively makes a channel definition available in the channel registry, making the channel available for subscription.

Parameters:

channelDef - the channel definition

approver - the user that approves this channel definition

approveDate - the date when the channel definition should be approved (can be future dated)

Throws:

Exception

disapproveChannelDefinition

void disapproveChannelDefinition(IChannelDefinition channelDef)

Deprecated.

Sets a channel definition as "unapproved". This effectively removes a channel definition from the channel registry, making the channel unavailable for subscription.

Parameters:

channelDef - the channel definition

Throws:

Exception

newChannelCategory

ChannelCategory newChannelCategory()

Deprecated.

Creates a new channel category.

Returns:

the new channel category

Throws:

Exception

newChannelCategory

ChannelCategory newChannelCategory(String name,
                                   String description,
                                   String creatorId)

Deprecated.

Creates a new channel category with the specified values.

Parameters:

name - the name of the category

description - the name of the description

creatorId - the id of the creator or system

Returns:

channelCategory the new channel category

Throws:

Exception

getChannelCategory

ChannelCategory getChannelCategory(String channelCategoryId)

Deprecated.

Gets an existing channel category.

Parameters:

channelCategoryId - the id of the category to get

Returns:

the channel category

Throws:

Exception

getTopLevelChannelCategory

ChannelCategory getTopLevelChannelCategory()

Deprecated.

Gets top level channel category

Returns:

the new channel category

Throws:

Exception

getAllChildCategories

ChannelCategory[] getAllChildCategories(ChannelCategory parent)

Deprecated.

Recursively gets all child channel categories for a parent category.

Returns:

channelCategories the children categories

Throws:

Exception

getAllChildChannels

IChannelDefinition[] getAllChildChannels(ChannelCategory parent)

Deprecated.

Recursively gets all child channel definitions for a parent category.

Returns:

channelDefinitions the children channel definitions

Throws:

Exception

getAllChildChannels

IChannelDefinition[] getAllChildChannels(ChannelCategory parent,
                                         IPerson person)

Deprecated.

Recursively gets all child channel definitions for a parent category that the given user is allowed to subscribe to.

Returns:

channelDefinitions the children channel definitions for the given person

getAllManageableChildChannels

IChannelDefinition[] getAllManageableChildChannels(ChannelCategory parent,
                                                   IPerson person)

Deprecated.

Recursively gets all child channel definitions for a parent category that the given user is allowed to manage.

Returns:

channelDefinitions the children channel definitions for the given person

getChildCategories

ChannelCategory[] getChildCategories(ChannelCategory parent)

Deprecated.

Gets all child channel categories for a parent category.

Returns:

channelCategories the children categories

Throws:

Exception

getChildChannels

IChannelDefinition[] getChildChannels(ChannelCategory parent)

Deprecated.

Gets all child channel definitions for a parent category.

Returns:

channelDefinitions the children channel definitions

Throws:

Exception

getChildChannels

IChannelDefinition[] getChildChannels(ChannelCategory parent,
                                      IPerson person)

Deprecated.

Gets all child channel definitions for a parent category that the given user is allowed to subscribe to.

Returns:

channelDefinitions the children channel definitions for the given person

getManageableChildChannels

IChannelDefinition[] getManageableChildChannels(ChannelCategory parent,
                                                IPerson person)

Deprecated.

Gets all child channel definitions for a parent category that the given user is allowed to manage.

Returns:

channelDefinitions the children channel definitions for the given person

getParentCategories

ChannelCategory[] getParentCategories(ChannelCategory child)

Deprecated.

Gets the immediate parent categories of this category.

Returns:

parents, the parent categories.

Throws:

Exception

getParentCategories

ChannelCategory[] getParentCategories(IChannelDefinition child)

Deprecated.

Gets the immediate parent categories of this channel definition.

Returns:

the parent categories.

Throws:

Exception

saveChannelCategory

void saveChannelCategory(ChannelCategory category)

Deprecated.

Persists a channel category.

Parameters:

category - the channel category to persist

Throws:

Exception

deleteChannelCategory

void deleteChannelCategory(ChannelCategory category)

Deprecated.

Deletes a channel category.

Parameters:

category - the channel category to delete

Throws:

Exception

addCategoryToCategory

void addCategoryToCategory(ChannelCategory source,
                           ChannelCategory destination)

Deprecated.

Makes one category a child of another.

Parameters:

source - the source category

destination - the destination category

Throws:

Exception

removeCategoryFromCategory

void removeCategoryFromCategory(ChannelCategory child,
                                ChannelCategory parent)

Deprecated.

Makes one category a child of another.

Parameters:

child - the category to remove

parent - the category to remove from

Throws:

Exception

addChannelToCategory

void addChannelToCategory(IChannelDefinition channelDef,
                          ChannelCategory category)

Deprecated.

Associates a channel definition with a category.

Parameters:

channelDef - the channel definition

category - the channel category to which to associate the channel definition

Throws:

Exception

removeChannelFromCategory

void removeChannelFromCategory(IChannelDefinition channelDef,
                               ChannelCategory category)

Deprecated.

Disassociates a channel definition from a category.

Parameters:

channelDef - the channel definition

category - the channel category from which to disassociate the channel definition

Throws:

Exception