org.jasig.portal
Interface ChannelRenderer.IWorker

All Superinterfaces:

Runnable, Task

All Known Implementing Classes:

ChannelRenderer.Worker

Enclosing class:

ChannelRenderer

protected static interface ChannelRenderer.IWorker
extends Task

Method Summary

boolean	done()
void	execute()
SAX2BufferImpl	getBuffer()
String	getChannelTitle() Get a Sring representing the dynamic channel title reported by the IChannel this ChannelRenderer rendered.
String	getCharacters() Returns a character output of a channel rendering.
long	getRenderTime()
boolean	isRenderedFromCache()
boolean	isSetRuntimeDataComplete()
void	setCharacterCache(String chars) Sets a character cache for the current rendering.
boolean	successful()

Methods inherited from interface org.jasig.portal.utils.threading.Task

getException

Methods inherited from interface java.lang.Runnable

run

Method Detail

isSetRuntimeDataComplete

boolean isSetRuntimeDataComplete()

execute

void execute()
             throws Exception

Throws:

Exception

successful

boolean successful()

getBuffer

SAX2BufferImpl getBuffer()

getCharacters

String getCharacters()

Returns a character output of a channel rendering.

setCharacterCache

void setCharacterCache(String chars)

Sets a character cache for the current rendering.

done

boolean done()

getRenderTime

long getRenderTime()

Returns:

the renderTime

isRenderedFromCache

boolean isRenderedFromCache()

Returns:

the renderedFromCache

getChannelTitle

String getChannelTitle()

Get a Sring representing the dynamic channel title reported by the IChannel this ChannelRenderer rendered. Returns null if the channel reported no such title or the channel isn't done rendering.

Returns:

dynamic channel title, or null if no title available.