org.jasig.portal.channel
Interface IChannelParameter

All Known Implementing Classes:

ChannelParameterImpl

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

@Deprecated
public interface IChannelParameter

IChannelParameter represents an interface for ChannelDefinition parameters. These parameters function as defaults for the channel and may optionally be overridden by end users.

Author:

Michael Ivanov, Jen Bourey, jbourey@unicon.net

Method Summary

String	getDescription() Deprecated. Get a description of this channel parameter.
String	getName() Deprecated. Get the name of the channel parameter.
boolean	getOverride() Deprecated. Get whether the value of this channel parameter may be overridden.
String	getValue() Deprecated. Get the default value of the channel parameter.
void	setDescription(String descr) Deprecated. Set the description of this channel parameter.
void	setName(String name) Deprecated. Set the name of the channel parameter.
void	setOverride(boolean override) Deprecated. Set whether this channel parameter may be overridden.
void	setValue(String value) Deprecated. Set the default value for this channel parameter.

Method Detail

getName

String getName()

Deprecated.

Get the name of the channel parameter.

Returns:

the name of the channel parameter.

getValue

String getValue()

Deprecated.

Get the default value of the channel parameter.

Returns:

the default value for this channel parameter.

getOverride

boolean getOverride()

Deprecated.

Get whether the value of this channel parameter may be overridden.

Returns:

true if value may be overridden, false otherwise.

getDescription

String getDescription()

Deprecated.

Get a description of this channel parameter.

Returns:

a description of this channel parameter.

setName

void setName(String name)

Deprecated.

Set the name of the channel parameter.

Parameters:

name - the name of the channel parameter

setValue

void setValue(String value)

Deprecated.

Set the default value for this channel parameter.

Parameters:

value - the default value for this channel parameter.

setOverride

void setOverride(boolean override)

Deprecated.

Set whether this channel parameter may be overridden.

Parameters:

override - true if the channel parameter may be overridden.

setDescription

void setDescription(String descr)

Deprecated.

Set the description of this channel parameter.

Parameters:

descr - description of this channel parameter.