org.jasig.portal.channel.dao
Interface IChannelDefinitionDao

All Known Implementing Classes:

JpaChannelDefinitionDao

public interface IChannelDefinitionDao

Provides APIs for creating, storing and retrieving IChannelDefinition objects.

Version:

$Revision: 19776 $

Method Summary

IChannelDefinition	createChannelDefinition(IChannelType channelType, String fname, String clazz, String name, String title) Creates, initializes and persists a new IChannelDefinition based on the specified parameters
void	deleteChannelDefinition(IChannelDefinition definition) Removes the specified IChannelDefinition from the persistent store.
IChannelDefinition	getChannelDefinition(int id) Get a IChannelDefinition for the specified id.
IChannelDefinition	getChannelDefinition(String fname) Get a IChannelDefinition for the specified functional name
IChannelDefinition	getChannelDefinitionByName(String name) Get a IChannelDefinition for the specified channel name.
List<IChannelDefinition>	getChannelDefinitions()
IChannelDefinition	updateChannelDefinition(IChannelDefinition definition) Persists changes to a IChannelDefinition.

Method Detail

createChannelDefinition

IChannelDefinition createChannelDefinition(IChannelType channelType,
                                           String fname,
                                           String clazz,
                                           String name,
                                           String title)

Creates, initializes and persists a new IChannelDefinition based on the specified parameters

Parameters:

channelType - The type the channel is based on

fname - A unique, human-readable key for the channel. Must match the regular expression FunctionalNameType.VALID_FNAME_PATTERN

clazz - A fully qualified Java class name that implements the IChannel interface. This is the class the portal will execute when rendering the channel.

name - The display name for the channel, this is shown in administrative UIs

title - The title used on portal generated chrome

Returns:

A newly created, initialized and persisted IChannelDefinition

Throws:

DataIntegrityViolationException - If a IChannelDefinition already exists for the provide arguments

IllegalArgumentException - If any of the parameters are null

updateChannelDefinition

IChannelDefinition updateChannelDefinition(IChannelDefinition definition)

Persists changes to a IChannelDefinition.

Parameters:

definition - The channel definition to store the changes for

Throws:

IllegalArgumentException - if definition is null.

deleteChannelDefinition

void deleteChannelDefinition(IChannelDefinition definition)

Removes the specified IChannelDefinition from the persistent store.

Parameters:

definition - The definition to remove.

Throws:

IllegalArgumentException - if definition is null.

getChannelDefinition

IChannelDefinition getChannelDefinition(int id)

Get a IChannelDefinition for the specified id.

Parameters:

id - The id to get the definition for.

Returns:

The channel definition for the id, null if no definition exists for the id.

getChannelDefinition

IChannelDefinition getChannelDefinition(String fname)

Get a IChannelDefinition for the specified functional name

Parameters:

fname - The fname to get the definition for.

Returns:

The channel definition for the fname, null if no definition exists for the fname.

Throws:

IllegalArgumentException - if fname is null.

getChannelDefinitionByName

IChannelDefinition getChannelDefinitionByName(String name)

Get a IChannelDefinition for the specified channel name.

Parameters:

name - The name to get the definition for.

Returns:

THe channel definition for the name, null if no definition exists for the name.

Throws:

IllegalArgumentException - if the name is null.

getChannelDefinitions

List<IChannelDefinition> getChannelDefinitions()

Returns:

A List of all persisted IChannelDefinitions