org.esupportail.portal.utils.channels
Interface ISubChannel

All Superinterfaces:
org.jasig.portal.ICacheable
All Known Implementing Classes:
SubChannel

public interface ISubChannel
extends org.jasig.portal.ICacheable

ISubChannel

Interface qui décrit les méthodes que doit implémenter une sous-channel (SubChannel)

(c)Copyright ESup-Portail 2004

Version:
1.0
Author:
Olivier Ziller

Method Summary
 void clearChannel()
          Méthode appellée lorsque la channel est réutilisée.
 java.lang.String getSSL()
          Récupère le fichier SSL à utiliser lors la transformation XSLT
 java.lang.String getXML()
          Récupère le XML à utiliser lors de l'affichage
 java.lang.String getXSL()
          Récupère le fichier XSL à utiliser lors de l'affichage
 java.util.Hashtable getXSLParameter()
          Récupère les paramètres à passer à la feuille XSL
 java.lang.Boolean init(org.jasig.portal.ChannelRuntimeData rd)
          Dans le cycle de vie d'une SubChannel, intervient en tout premier, juste après l'instanciation
 void log(org.apache.log4j.Priority level, java.lang.String logMessage)
          Log d'un message selon un niveau de priorité
 void log(java.lang.String logMessage)
          Log d'un message dans le fichier uportal.log
 void renderXML(org.xml.sax.ContentHandler out)
          Fait le rendu xml.
 void setOutput()
          Avant-derniere méthode appelée lors du cycle de vie d'une sous-channel Permet de positionner le nom du fichier xsl ou ssl
 void setSSL(java.lang.String ssl)
          Positionne la feuille ssl (null si pas de feuille ssl)
 java.lang.Boolean setXML()
          Dans le cycle de vie d'une sous-channel, méthode qui est appelée après l'initiation
 void setXML(java.lang.String xml)
          Positionne la valeur du xml
 void setXSL(java.lang.String xsl)
          Positionne la valeur du fichier xsl
 void setXSLParameter(java.util.Hashtable h)
          Positionne les paramètres de la feuille Xsl
 
Methods inherited from interface org.jasig.portal.ICacheable
generateKey, isCacheValid
 

Method Detail

getXML

public java.lang.String getXML()
Récupère le XML à utiliser lors de l'affichage

Returns:

getXSL

public java.lang.String getXSL()
Récupère le fichier XSL à utiliser lors de l'affichage

Returns:

getSSL

public java.lang.String getSSL()
Récupère le fichier SSL à utiliser lors la transformation XSLT

Returns:

getXSLParameter

public java.util.Hashtable getXSLParameter()
Récupère les paramètres à passer à la feuille XSL

Returns:

setXML

public void setXML(java.lang.String xml)
            throws FrameWorkException
Positionne la valeur du xml

Parameters:
xml -
Throws:
FrameWorkException

setXSL

public void setXSL(java.lang.String xsl)
Positionne la valeur du fichier xsl

Parameters:
xsl -

setSSL

public void setSSL(java.lang.String ssl)
Positionne la feuille ssl (null si pas de feuille ssl)

Parameters:
ssl -

setXSLParameter

public void setXSLParameter(java.util.Hashtable h)
Positionne les paramètres de la feuille Xsl

Parameters:
h -

init

public java.lang.Boolean init(org.jasig.portal.ChannelRuntimeData rd)
                       throws org.jasig.portal.PortalException,
                              FrameWorkException
Dans le cycle de vie d'une SubChannel, intervient en tout premier, juste après l'instanciation

Parameters:
rd - Les RuntimeData de la channel principale (MainChannel)
Returns:
Indique si le cycle de vie peut se poursuivre (passer à setXML)
Throws:
org.jasig.portal.PortalException
FrameWorkException

setXML

public java.lang.Boolean setXML()
                         throws FrameWorkException
Dans le cycle de vie d'une sous-channel, méthode qui est appelée après l'initiation

Returns:
Une réussite (ou non) qui indique si le cycle de vie se poursuit (passer à setOutput)
Throws:
FrameWorkException

setOutput

public void setOutput()
               throws FrameWorkException
Avant-derniere méthode appelée lors du cycle de vie d'une sous-channel Permet de positionner le nom du fichier xsl ou ssl

Throws:
FrameWorkException

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws org.jasig.portal.PortalException
Fait le rendu xml. Le moins de traitement doit être fait ici.

Parameters:
out -
Throws:
org.jasig.portal.PortalException

clearChannel

public void clearChannel()
Méthode appellée lorsque la channel est réutilisée. Permet d'initialiser certaines données entre 2 utilisations (les paramètres XSL par exemple)


log

public void log(java.lang.String logMessage)
Log d'un message dans le fichier uportal.log

Parameters:
logMessage -

log

public void log(org.apache.log4j.Priority level,
                java.lang.String logMessage)
Log d'un message selon un niveau de priorité

Parameters:
level -
logMessage -