org.jasig.portal
Class AbstractChannelRegistryStore

java.lang.Object
  org.jasig.portal.AbstractChannelRegistryStore

All Implemented Interfaces:

IChannelRegistryStore

Direct Known Subclasses:

JpaChannelRegistryStore

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

@Deprecated
public abstract class AbstractChannelRegistryStore
extends Object
implements IChannelRegistryStore

Abstract channel registry store. Be aware that calls to methods within this class may be cached. The cache is configured in /uportal-impl/src/main/resources/properties/contexts/channelContainerContext.xml

Constructor Summary

AbstractChannelRegistryStore()
Deprecated.

Method Summary

void	addCategoryToCategory(ChannelCategory child, ChannelCategory parent) 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	disapproveChannelDefinition(IChannelDefinition channelDef) Deprecated. Removes a channel from the channel registry by changing its status from "approved" to "unapproved".
ChannelCategory[]	getAllChildCategories(ChannelCategory parent) Deprecated. Gets all child channel categories for a parent category.
IChannelDefinition[]	getAllChildChannels(ChannelCategory parent) Deprecated. 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.
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.
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.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portal.IChannelRegistryStore

deleteChannelDefinition, deleteChannelType, getChannelDefinition, getChannelDefinition, getChannelDefinitionByName, getChannelDefinitions, getChannelDefinitions, getChannelType, getChannelType, getChannelTypes, getOrCreateChannelType, newChannelDefinition, newChannelType, saveChannelDefinition, saveChannelType

Constructor Detail

AbstractChannelRegistryStore

public AbstractChannelRegistryStore()

Deprecated.

Method Detail

addCategoryToCategory

public void addCategoryToCategory(ChannelCategory child,
                                  ChannelCategory parent)
                           throws GroupsException

Deprecated.

Makes one category a child of another.

Specified by:

addCategoryToCategory in interface IChannelRegistryStore

Parameters:

child - the source category

parent - the destination category

Throws:

GroupsException

addChannelToCategory

public void addChannelToCategory(IChannelDefinition channelDef,
                                 ChannelCategory category)
                          throws PortalException

Deprecated.

Associates a channel definition with a category.

Specified by:

addChannelToCategory in interface IChannelRegistryStore

Parameters:

channelDef - the channel definition

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

Throws:

PortalException

approveChannelDefinition

public 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 to those authorized to subscribe to it. This method is a convenience method. As an alternative to calling this method, one could simply set the approver ID and approval date and then call saveChannelDefinition(ChannelDefinition chanDef).

Specified by:

approveChannelDefinition in interface IChannelRegistryStore

Parameters:

channelDef - the channel definition to approve

approver - the user that approves this channel definition

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

Throws:

Exception

deleteChannelCategory

public void deleteChannelCategory(ChannelCategory category)
                           throws GroupsException

Deprecated.

Deletes a channel category.

Specified by:

deleteChannelCategory in interface IChannelRegistryStore

Parameters:

category - the channel category to delete

Throws:

GroupsException

disapproveChannelDefinition

public void disapproveChannelDefinition(IChannelDefinition channelDef)

Deprecated.

Removes a channel from the channel registry by changing its status from "approved" to "unapproved". Afterwards, no one will be able to subscribe to or render the channel. This method is a convenience method. As an alternative to calling this method, one could simply set the approver ID and approval date to NULL and then call saveChannelDefinition(ChannelDefinition chanDef).

Specified by:

disapproveChannelDefinition in interface IChannelRegistryStore

Parameters:

channelDef - the channel definition to disapprove

Throws:

Exception

getAllChildCategories

public ChannelCategory[] getAllChildCategories(ChannelCategory parent)

Deprecated.

Gets all child channel categories for a parent category.

Specified by:

getAllChildCategories in interface IChannelRegistryStore

Returns:

channelCategories the children categories

Throws:

GroupsException

getAllChildChannels

public IChannelDefinition[] getAllChildChannels(ChannelCategory parent)

Deprecated.

Gets all child channel definitions for a parent category.

Specified by:

getAllChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions

Throws:

SQLException

GroupsException

getAllChildChannels

public IChannelDefinition[] getAllChildChannels(ChannelCategory parent,
                                                IPerson person)

Deprecated.

Description copied from interface: IChannelRegistryStore

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

Specified by:

getAllChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions for the given person

getAllManageableChildChannels

public IChannelDefinition[] getAllManageableChildChannels(ChannelCategory parent,
                                                          IPerson person)

Deprecated.

Description copied from interface: IChannelRegistryStore

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

Specified by:

getAllManageableChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions for the given person

getChannelCategory

public ChannelCategory getChannelCategory(String channelCategoryId)
                                   throws GroupsException

Deprecated.

Gets an existing channel category.

Specified by:

getChannelCategory in interface IChannelRegistryStore

Parameters:

channelCategoryId - the id of the category to get

Returns:

channelCategory the channel category

Throws:

GroupsException

getChildCategories

public ChannelCategory[] getChildCategories(ChannelCategory parent)
                                     throws GroupsException

Deprecated.

Gets all child channel categories for a parent category.

Specified by:

getChildCategories in interface IChannelRegistryStore

Returns:

channelCategories the children categories

Throws:

GroupsException

getChildChannels

public IChannelDefinition[] getChildChannels(ChannelCategory parent)

Deprecated.

Gets all child channel definitions for a parent category.

Specified by:

getChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions

Throws:

SQLException

GroupsException

getChildChannels

public 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.

Specified by:

getChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions for the given person

getManageableChildChannels

public IChannelDefinition[] getManageableChildChannels(ChannelCategory parent,
                                                       IPerson person)

Deprecated.

Description copied from interface: IChannelRegistryStore

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

Specified by:

getManageableChildChannels in interface IChannelRegistryStore

Returns:

channelDefinitions the children channel definitions for the given person

getParentCategories

public ChannelCategory[] getParentCategories(ChannelCategory child)
                                      throws GroupsException

Deprecated.

Gets the immediate parent categories of this category.

Specified by:

getParentCategories in interface IChannelRegistryStore

Returns:

parents, the parent categories.

Throws:

GroupsException

getParentCategories

public ChannelCategory[] getParentCategories(IChannelDefinition child)
                                      throws GroupsException

Deprecated.

Gets the immediate parent categories of this channel definition.

Specified by:

getParentCategories in interface IChannelRegistryStore

Returns:

parents, the parent categories.

Throws:

GroupsException

getTopLevelChannelCategory

public ChannelCategory getTopLevelChannelCategory()
                                           throws GroupsException

Deprecated.

Gets top level channel category

Specified by:

getTopLevelChannelCategory in interface IChannelRegistryStore

Returns:

channelCategories the new channel category

Throws:

GroupsException

newChannelCategory

public ChannelCategory newChannelCategory()
                                   throws GroupsException

Deprecated.

Creates a new channel category.

Specified by:

newChannelCategory in interface IChannelRegistryStore

Returns:

channelCategory the new channel category

Throws:

GroupsException

newChannelCategory

public ChannelCategory newChannelCategory(String name,
                                          String description,
                                          String creatorId)
                                   throws GroupsException

Deprecated.

Creates a new channel category with the specified values.

Specified by:

newChannelCategory in interface IChannelRegistryStore

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:

GroupsException

removeCategoryFromCategory

public void removeCategoryFromCategory(ChannelCategory child,
                                       ChannelCategory parent)
                                throws GroupsException

Deprecated.

Makes one category a child of another.

Specified by:

removeCategoryFromCategory in interface IChannelRegistryStore

Parameters:

child - the category to remove

parent - the category to remove from

Throws:

GroupsException

removeChannelFromCategory

public void removeChannelFromCategory(IChannelDefinition channelDef,
                                      ChannelCategory category)
                               throws PortalException

Deprecated.

Disassociates a channel definition from a category.

Specified by:

removeChannelFromCategory in interface IChannelRegistryStore

Parameters:

channelDef - the channel definition

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

Throws:

PortalException

saveChannelCategory

public void saveChannelCategory(ChannelCategory category)
                         throws GroupsException

Deprecated.

Persists a channel category.

Specified by:

saveChannelCategory in interface IChannelRegistryStore

Parameters:

category - the channel category to persist

Throws:

GroupsException