|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
public void setStaticData(ChannelStaticData sd) throws PortalException
sd
- channel static data
PortalException
ChannelStaticData
public void setRuntimeData(ChannelRuntimeData rd) throws PortalException
rd
- channel runtime data
PortalException
ChannelRuntimeData
public void receiveEvent(PortalEvent ev)
ev
- PortalEvent objectPortalEvent
public ChannelRuntimeProperties getRuntimeProperties()
ChannelRuntimeProperties
public void renderXML(org.xml.sax.ContentHandler out) throws PortalException
out
- the SAX ContentHandler to output content to
PortalException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |