org.jasig.portal
Interface IChannel

All Known Subinterfaces:

ICharacterChannel, INavigationModel, IPortletAdaptor, IPrivilegedChannel, IResetableChannel, IServant

All Known Implementing Classes:

AdminNavChannel, BaseChannel, CAbstractXslt, CApplet, CError, CGenericXSLT, CGroupsManager, CGroupsManagerServant, Channel, CHeader, CHistory, CImage, CInlineFrame, CLogin, CMissingProperties, CNumberGuess, CPermissionsManager, CPermissionsManagerServant, CPersonAttributes, CSecureInfo, CSelectSystemProfile, CSessionLocalesSelector, CSiteMap, CSkinSelector, CSnoop, CSpringPortletAdaptor, CSqlQuery, CSyndFeed, CThrower, CTimeout, CTimeTitle, CURLSelector, CUserLocalesSelector, CUserManager, CUserPreferences, CUserPreferences, CVersion, CViewer, CWebProxy, DlmIntroChannel, ListModel, MultithreadedCacheableChannelAdapter, MultithreadedCacheableCharacterChannelAdapter, MultithreadedCacheableMimeResponseChannelAdapter, MultithreadedCacheableMimeResponseCharacterChannelAdapter, MultithreadedChannelAdapter, MultithreadedCharacterChannelAdapter, MultithreadedMimeResponseChannelAdapter, MultithreadedMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedCacheableChannelAdapter, MultithreadedPrivilegedCacheableCharacterChannelAdapter, MultithreadedPrivilegedCacheableDirectResponseCharacterChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedChannelAdapter, MultithreadedPrivilegedCharacterChannelAdapter, MultithreadedPrivilegedMimeResponseChannelAdapter, MultithreadedPrivilegedMimeResponseCharacterChannelAdapter, ServantChannel, StandaloneChannelRenderer, TabColumnPrefsState, TabColumnPrefsState, TabColumnPrefsState.DefaultState, TabColumnPrefsState.DefaultState, TabColumnPrefsState.NewChannelState, TabColumnPrefsState.NewChannelState, TabColumnPrefsState.ParametersState, TabColumnPrefsState.ParametersState, TabColumnPrefsState.ResetLayoutState, TabColumnPrefsState.ResetLayoutState, TabColumnPrefsState.SelectSkinsState, TabColumnPrefsState.SelectSkinsState

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface IChannel

An interface presented by a channel to a portal. A channel is a stateful entity. The main part of the channel lifecycle is the rendering cycle. The rendering cycle starts with an invokation of the setRuntimeData(org.jasig.portal.ChannelRuntimeData) method for updating channel state, and is eventually followed by a call to the renderXML(org.xml.sax.ContentHandler) method that retrieves the current state of the channel. These are the main two methods of the interface.

Version:

$Revision: 19776 $

Author:

Peter Kharchenko pkharchenko@interactivebusiness.com"

Method Summary

ChannelRuntimeProperties	getRuntimeProperties() Deprecated. Acquires ChannelRuntimeProperites from the channel.
void	receiveEvent(PortalEvent ev) Deprecated. Passes an outside event to a channel.
void	renderXML(ContentHandler out) Deprecated. Ask channel to render its content.
void	setRuntimeData(ChannelRuntimeData rd) Deprecated. Passes ChannelRuntimeData to the channel.
void	setStaticData(ChannelStaticData sd) Deprecated. Passes ChannelStaticData to the channel.

Method Detail

setStaticData

void setStaticData(ChannelStaticData sd)
                   throws PortalException

Deprecated.

Passes ChannelStaticData to the channel. This is done during channel instantiation time. see org.jasig.portal.ChannelStaticData

Parameters:

sd - channel static data

Throws:

PortalException

See Also:

ChannelStaticData

setRuntimeData

void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException

Deprecated.

Passes ChannelRuntimeData to the channel. This function is called prior to the renderXML() call.

Parameters:

rd - channel runtime data

Throws:

PortalException

See Also:

ChannelRuntimeData

receiveEvent

void receiveEvent(PortalEvent ev)

Deprecated.

Passes an outside event to a channel. Events should normally come from the LayoutBean.

Parameters:

ev - PortalEvent object

See Also:

PortalEvent

getRuntimeProperties

ChannelRuntimeProperties getRuntimeProperties()

Deprecated.

Acquires ChannelRuntimeProperites from the channel. This function may be called by the portal framework throughout the session.

See Also:

ChannelRuntimeProperties

renderXML

void renderXML(ContentHandler out)
               throws PortalException

Deprecated.

Ask channel to render its content.

Parameters:

out - the SAX ContentHandler to output content to

Throws:

PortalException