org.jasig.portal
Interface IResetableChannel

All Superinterfaces:
IChannel
All Known Subinterfaces:
IPortletAdaptor
All Known Implementing Classes:
CSpringPortletAdaptor

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public interface IResetableChannel
extends IChannel

Describes an IChannel that can handle being refereshed or reset by the container after an error.

Version:
$Revision$
Author:
Eric Dalquist

Method Summary
 void prepareForRefresh()
          Deprecated. Prepare to be refereshed after an error.
 void prepareForReset()
          Deprecated. Prepare to be reset after an error.
 
Methods inherited from interface org.jasig.portal.IChannel
getRuntimeProperties, receiveEvent, renderXML, setRuntimeData, setStaticData
 

Method Detail

prepareForRefresh

void prepareForRefresh()
Deprecated. 
Prepare to be refereshed after an error. Information about the last request should be cleared and the channel should be in a renderable state when this method returns. If the channel also implements IPrivileged IPrivileged.setPortalControlStructures(PortalControlStructures) must be called before this method. IChannel.setRuntimeData(ChannelRuntimeData) must also be called before this method.


prepareForReset

void prepareForReset()
Deprecated. 
Prepare to be reset after an error. This channel instance may be destroyed and re-created during the reset process so this method gives the old channel a chance to clean up before the reset. State information stored anywhere outside of ChannelRuntimeData should be cleared. If the channel also implements IPrivileged IPrivileged.setPortalControlStructures(PortalControlStructures) must be called before this method. IChannel.setRuntimeData(ChannelRuntimeData) must also be called before this method.



Copyright © 2010 Jasig. All Rights Reserved.