org.jasig.portal.channel
Interface IChannelDefinition

All Superinterfaces:

IBasicEntity

All Known Implementing Classes:

ChannelDefinitionImpl, XmlGeneratingBaseChannelDefinition

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

@Deprecated
public interface IChannelDefinition
extends IBasicEntity

Method Summary

void	addLocalizedDescription(String locale, String chanDesc) Deprecated.
void	addLocalizedName(String locale, String chanName) Deprecated.
void	addLocalizedTitle(String locale, String chanTitle) Deprecated.
void	addParameter(IChannelParameter parameter) Deprecated. Adds a parameter to this channel definition
void	addParameter(String name, String value, boolean override) Deprecated. Adds a parameter to this channel definition
void	addParameter(String name, String value, String override) Deprecated. Use addParameter(String, String, boolean) instead.
void	clearParameters() Deprecated.
Date	getApprovalDate() Deprecated.
int	getApproverId() Deprecated.
String	getDescription() Deprecated.
String	getDescription(String locale) Deprecated.
Element	getDocument(Document doc, String idTag) Deprecated.
Element	getDocument(Document doc, String idTag, String statusMsg, int errorId) Deprecated.
EntityIdentifier	getEntityIdentifier() Deprecated. Implementation required by IBasicEntity interface.
Date	getExpirationDate() Deprecated.
int	getExpirerId() Deprecated.
String	getFName() Deprecated.
int	getId() Deprecated.
String	getJavaClass() Deprecated.
ChannelLifecycleState	getLifecycleState() Deprecated.
String	getLocale() Deprecated.
String	getName() Deprecated.
String	getName(String locale) Deprecated.
IChannelParameter	getParameter(String key) Deprecated.
Set<IChannelParameter>	getParameters() Deprecated.
Map<String,IChannelParameter>	getParametersAsUnmodifiableMap() Deprecated.
Date	getPublishDate() Deprecated.
int	getPublisherId() Deprecated.
int	getTimeout() Deprecated.
String	getTitle() Deprecated.
String	getTitle(String locale) Deprecated.
IChannelType	getType() Deprecated.
int	getTypeId() Deprecated. use getType()
boolean	hasAbout() Deprecated.
boolean	hasHelp() Deprecated.
boolean	isEditable() Deprecated.
boolean	isPortlet() Deprecated. Returns true if this channel definition defines a portlet.
boolean	isSecure() Deprecated.
void	removeParameter(IChannelParameter parameter) Deprecated. Removes a parameter from this channel definition
void	removeParameter(String name) Deprecated. Removes a parameter from this channel definition
void	replaceParameters(Set<IChannelParameter> parameters) Deprecated.
void	setApprovalDate(Date approvalDate) Deprecated.
void	setApproverId(int approvalId) Deprecated.
void	setDescription(String descr) Deprecated.
void	setEditable(boolean editable) Deprecated.
void	setExpirationDate(Date expirationDate) Deprecated.
void	setExpirerId(int expirerId) Deprecated.
void	setFName(String fname) Deprecated.
void	setHasAbout(boolean hasAbout) Deprecated.
void	setHasHelp(boolean hasHelp) Deprecated.
void	setIsSecure(boolean isSecure) Deprecated.
void	setJavaClass(String javaClass) Deprecated.
void	setLocale(String locale) Deprecated.
void	setName(String name) Deprecated.
void	setParameters(Set<IChannelParameter> parameters) Deprecated.
void	setPublishDate(Date publishDate) Deprecated.
void	setPublisherId(int publisherId) Deprecated.
void	setTimeout(int timeout) Deprecated.
void	setTitle(String title) Deprecated.
void	setType(IChannelType channelType) Deprecated.

Method Detail

getLifecycleState

ChannelLifecycleState getLifecycleState()

Deprecated.

getId

int getId()

Deprecated.

getFName

String getFName()

Deprecated.

getName

String getName()

Deprecated.

getDescription

String getDescription()

Deprecated.

getTitle

String getTitle()

Deprecated.

getJavaClass

String getJavaClass()

Deprecated.

getTimeout

int getTimeout()

Deprecated.

getTypeId

@Deprecated
int getTypeId()

Deprecated. use getType()

getType

IChannelType getType()

Deprecated.

getPublisherId

int getPublisherId()

Deprecated.

getApproverId

int getApproverId()

Deprecated.

getPublishDate

Date getPublishDate()

Deprecated.

getApprovalDate

Date getApprovalDate()

Deprecated.

getExpirerId

int getExpirerId()

Deprecated.

getExpirationDate

Date getExpirationDate()

Deprecated.

isEditable

boolean isEditable()

Deprecated.

hasHelp

boolean hasHelp()

Deprecated.

hasAbout

boolean hasAbout()

Deprecated.

isSecure

boolean isSecure()

Deprecated.

isPortlet

boolean isPortlet()

Deprecated.

Returns true if this channel definition defines a portlet. Returns false if this channel definition does not define a portlet or whether this channel definition defines a portlet or not cannot be determined because this definition's channel class is not set or cannot be loaded.

Returns:

true if we know we're a portlet, false otherwise

getParameters

Set<IChannelParameter> getParameters()

Deprecated.

getParameter

IChannelParameter getParameter(String key)

Deprecated.

getParametersAsUnmodifiableMap

Map<String,IChannelParameter> getParametersAsUnmodifiableMap()

Deprecated.

getLocale

String getLocale()

Deprecated.

getName

String getName(String locale)

Deprecated.

getDescription

String getDescription(String locale)

Deprecated.

getTitle

String getTitle(String locale)

Deprecated.

setFName

void setFName(String fname)

Deprecated.

setName

void setName(String name)

Deprecated.

setDescription

void setDescription(String descr)

Deprecated.

setTitle

void setTitle(String title)

Deprecated.

setJavaClass

void setJavaClass(String javaClass)

Deprecated.

setTimeout

void setTimeout(int timeout)

Deprecated.

setType

void setType(IChannelType channelType)

Deprecated.

setPublisherId

void setPublisherId(int publisherId)

Deprecated.

setApproverId

void setApproverId(int approvalId)

Deprecated.

setPublishDate

void setPublishDate(Date publishDate)

Deprecated.

setApprovalDate

void setApprovalDate(Date approvalDate)

Deprecated.

setExpirerId

void setExpirerId(int expirerId)

Deprecated.

setExpirationDate

void setExpirationDate(Date expirationDate)

Deprecated.

setEditable

void setEditable(boolean editable)

Deprecated.

setHasHelp

void setHasHelp(boolean hasHelp)

Deprecated.

setHasAbout

void setHasAbout(boolean hasAbout)

Deprecated.

setIsSecure

void setIsSecure(boolean isSecure)

Deprecated.

setLocale

void setLocale(String locale)

Deprecated.

clearParameters

void clearParameters()

Deprecated.

setParameters

void setParameters(Set<IChannelParameter> parameters)

Deprecated.

replaceParameters

void replaceParameters(Set<IChannelParameter> parameters)

Deprecated.

addLocalizedTitle

void addLocalizedTitle(String locale,
                       String chanTitle)

Deprecated.

addLocalizedName

void addLocalizedName(String locale,
                      String chanName)

Deprecated.

addLocalizedDescription

void addLocalizedDescription(String locale,
                             String chanDesc)

Deprecated.

getEntityIdentifier

EntityIdentifier getEntityIdentifier()

Deprecated.

Implementation required by IBasicEntity interface.

Specified by:

getEntityIdentifier in interface IBasicEntity

Returns:

EntityIdentifier

addParameter

void addParameter(IChannelParameter parameter)

Deprecated.

Adds a parameter to this channel definition

Parameters:

parameter - the channel parameter to add

addParameter

void addParameter(String name,
                  String value,
                  String override)

Deprecated. Use addParameter(String, String, boolean) instead.

addParameter

void addParameter(String name,
                  String value,
                  boolean override)

Deprecated.

Adds a parameter to this channel definition

Parameters:

name - the channel parameter name

value - the channel parameter value

override - the channel parameter override setting

removeParameter

void removeParameter(IChannelParameter parameter)

Deprecated.

Removes a parameter from this channel definition

Parameters:

parameter - the channel parameter to remove

removeParameter

void removeParameter(String name)

Deprecated.

Removes a parameter from this channel definition

Parameters:

name - the parameter name

getDocument

@Deprecated
Element getDocument(Document doc,
                               String idTag,
                               String statusMsg,
                               int errorId)

Deprecated.

getDocument

@Deprecated
Element getDocument(Document doc,
                               String idTag)

Deprecated.

return an xml representation of this channel