org.esupportail.portal.utils.channels
Class SubChannel

java.lang.Object
  extended byorg.esupportail.portal.utils.channels.SubChannel
All Implemented Interfaces:
org.jasig.portal.ICacheable, ISubChannel
Direct Known Subclasses:
Confirm, FatalError, Message, RestrictedAction, Todo

public abstract class SubChannel
extends java.lang.Object
implements ISubChannel

SubChannel

Classe abstraite qui propose une implémentation "type" de l'interface ISubChannel

(c)Copyright ESup-Portail 2004

Version:
$Revision 2.0 $, $Revision 2.0 $
Author:
Olivier Ziller

Constructor Summary
SubChannel(MainChannel mainChannel)
          Constructeur d'une SubChannel Positionne une référence vers la channel principale
 
Method Summary
 void addDefaultXslParameters()
          Ajoute des paramètres XSL par défaut aux paramètres existant baseActionURL = url vers la channel en cours prefForm = prefixe à utiliser dans la feuille xslt pour s'assurer de l'unicité du nom des objects javascript mediaPath = chemins d'accès aux médias (images)
 void addDownloadXslParameter()
          Ajoute le paramètre pour le download aux paramètres existants baseDownloadURL = url vers la channel en cours pour une opération de téléchargement
 void clearChannel()
          Implémentation ISubChannel
 org.jasig.portal.ChannelCacheKey generateKey()
          Implémentation ISubChannel
 MainChannel getMainChannel()
          Récupére l'instance de la channel principale
 java.lang.String getMediaPath()
          Retourne le chemin d'accès aux médis
static java.lang.String getPackageName(java.lang.Class c)
          Retourne le nom du package en cours
 org.jasig.portal.ChannelRuntimeData getRuntimeData()
          Récupère les runtimeData de la sous-channel
 java.lang.String getSSL()
          Implémentation ISubChannel
 java.lang.String getXML()
          Implémentation ISubChannel
 java.lang.String getXSL()
          Implémentation ISubChannel
 java.util.Hashtable getXSLParameter()
          Implémentation ISubChannel
 java.lang.Boolean init(org.jasig.portal.ChannelRuntimeData rd)
          Implémentation ISubChannel
 boolean isCacheValid(java.lang.Object validity)
          Implémentation ISubChannel
 void log(org.apache.log4j.Priority level, java.lang.String logMessage)
          Deprecated.  
 void log(java.lang.String logMessage)
          Deprecated.  
 void renderXML(org.xml.sax.ContentHandler out)
          Implémentation ISubChannel
 void setDefaultXslParameters()
          Efface les paramètres XSL en cours et ajoute ceux par défaut
 void setOutput()
          Implémentation ISubChannel
 void setSSL(java.lang.String ssl)
          Implémentation ISubChannel
 java.lang.Boolean setXML()
          Implémentation ISubChannel
 void setXML(java.lang.String string)
          Implémentation ISubChannel
 void setXSL(java.lang.String xsl)
          Implémentation ISubChannel
 void setXSLParameter(java.util.Hashtable hashtable)
          Implémentation ISubChannel
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SubChannel

public SubChannel(MainChannel mainChannel)
Constructeur d'une SubChannel Positionne une référence vers la channel principale

Parameters:
mainChannel - instance de la channel principale
Method Detail

init

public java.lang.Boolean init(org.jasig.portal.ChannelRuntimeData rd)
                       throws org.jasig.portal.PortalException,
                              FrameWorkException
Implémentation ISubChannel

Specified by:
init in interface ISubChannel
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

clearChannel

public void clearChannel()
Implémentation ISubChannel

Specified by:
clearChannel in interface ISubChannel

setOutput

public void setOutput()
               throws FrameWorkException
Implémentation ISubChannel

Specified by:
setOutput in interface ISubChannel
Throws:
FrameWorkException

renderXML

public void renderXML(org.xml.sax.ContentHandler out)
               throws org.jasig.portal.PortalException
Implémentation ISubChannel

Specified by:
renderXML in interface ISubChannel
Parameters:
out -
Throws:
org.jasig.portal.PortalException

getXML

public java.lang.String getXML()
Implémentation ISubChannel

Specified by:
getXML in interface ISubChannel
Returns:

setXML

public void setXML(java.lang.String string)
            throws FrameWorkException
Implémentation ISubChannel

Specified by:
setXML in interface ISubChannel
Parameters:
string -
Throws:
FrameWorkException

setXML

public java.lang.Boolean setXML()
                         throws FrameWorkException
Implémentation ISubChannel

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

getXSLParameter

public java.util.Hashtable getXSLParameter()
Implémentation ISubChannel

Specified by:
getXSLParameter in interface ISubChannel
Returns:

setXSLParameter

public void setXSLParameter(java.util.Hashtable hashtable)
Implémentation ISubChannel

Specified by:
setXSLParameter in interface ISubChannel
Parameters:
hashtable -

getMainChannel

public MainChannel getMainChannel()
Récupére l'instance de la channel principale

Returns:
Une référence vers l'instance de la channel principale

addDefaultXslParameters

public void addDefaultXslParameters()
Ajoute des paramètres XSL par défaut aux paramètres existant baseActionURL = url vers la channel en cours prefForm = prefixe à utiliser dans la feuille xslt pour s'assurer de l'unicité du nom des objects javascript mediaPath = chemins d'accès aux médias (images)


addDownloadXslParameter

public void addDownloadXslParameter()
Ajoute le paramètre pour le download aux paramètres existants baseDownloadURL = url vers la channel en cours pour une opération de téléchargement


setDefaultXslParameters

public void setDefaultXslParameters()
Efface les paramètres XSL en cours et ajoute ceux par défaut


getRuntimeData

public org.jasig.portal.ChannelRuntimeData getRuntimeData()
Récupère les runtimeData de la sous-channel

Returns:
les runtimeData de la sous-channel

getSSL

public java.lang.String getSSL()
Implémentation ISubChannel

Specified by:
getSSL in interface ISubChannel
Returns:

getXSL

public java.lang.String getXSL()
Implémentation ISubChannel

Specified by:
getXSL in interface ISubChannel
Returns:

setSSL

public void setSSL(java.lang.String ssl)
Implémentation ISubChannel

Specified by:
setSSL in interface ISubChannel
Parameters:
ssl -

setXSL

public void setXSL(java.lang.String xsl)
Implémentation ISubChannel

Specified by:
setXSL in interface ISubChannel
Parameters:
xsl -

getMediaPath

public java.lang.String getMediaPath()
Retourne le chemin d'accès aux médis

Returns:
le chemin d'accès aux médias

getPackageName

public static java.lang.String getPackageName(java.lang.Class c)
Retourne le nom du package en cours

Returns:
nom du package

generateKey

public org.jasig.portal.ChannelCacheKey generateKey()
Implémentation ISubChannel

Specified by:
generateKey in interface org.jasig.portal.ICacheable

isCacheValid

public boolean isCacheValid(java.lang.Object validity)
Implémentation ISubChannel

Specified by:
isCacheValid in interface org.jasig.portal.ICacheable

log

public void log(java.lang.String logMessage)
Deprecated.  

Implémentation ISubChannel

Specified by:
log in interface ISubChannel
Parameters:
logMessage -

log

public void log(org.apache.log4j.Priority level,
                java.lang.String logMessage)
Deprecated.  

Implémentation ISubChannel

Specified by:
log in interface ISubChannel
Parameters:
level -
logMessage -