uPortal 2.4.1
API Documentation

org.jasig.portal
Interface IChannel

All Known Subinterfaces:
ICharacterChannel, IPrivilegedChannel, IServant
All Known Implementing Classes:
BaseChannel, org.jasig.portal.channels.UserPreferences.BaseState, CError, CGroupsManagerServant, CLogin, CNumberGuess, CPermissionsManager, CPermissionsManagerServant, CSecureInfo, CSnoop, CUserPreferences, MultithreadedChannelAdapter, MultithreadedCharacterChannelAdapter, MultithreadedPrivilegedCacheableChannelAdapter, MultithreadedPrivilegedCacheableCharacterChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseChannelAdapter, MultithreadedPrivilegedCacheableMimeResponseCharacterChannelAdapter, MultithreadedPrivilegedChannelAdapter, MultithreadedPrivilegedCharacterChannelAdapter, MultithreadedPrivilegedMimeResponseChannelAdapter, MultithreadedPrivilegedMimeResponseCharacterChannelAdapter

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: 1.18 $
Author:
Peter Kharchenko

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

Method Detail

setStaticData

public void setStaticData(ChannelStaticData sd)
                   throws PortalException
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

public void setRuntimeData(ChannelRuntimeData rd)
                    throws PortalException
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

public void receiveEvent(PortalEvent ev)
Passes an outside event to a channel. Events should normally come from the LayoutBean.

Parameters:
ev - PortalEvent object
See Also:
PortalEvent

getRuntimeProperties

public ChannelRuntimeProperties getRuntimeProperties()
Acquires ChannelRuntimeProperites from the channel. This function may be called by the portal framework throughout the session.

See Also:
ChannelRuntimeProperties

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws PortalException
Ask channel to render its content.

Parameters:
out - the SAX ContentHandler to output content to
Throws:
PortalException

uPortal 2.4.1
API Documentation