|
channels 1.0 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.esupportail.portal.utils.channels.MainChannel
MainChannel
Implémentation "type" d'une classe principale d'un channel (MainChannel)
(c)Copyright ESup-Portail 2004
Constructor Summary | |
MainChannel()
|
Method Summary | |
void |
calcCurrentAction(org.jasig.portal.ChannelRuntimeData rd)
Détermination de l'action en cours à partir des paramères HTTP |
void |
clearChannelsMap()
Effacement de la liste des subChannels déjà instanciées |
void |
clearServantResults()
Mise à null du résultat d'un servant |
org.jasig.portal.ChannelCacheKey |
generateKey()
|
IConfigActions |
getConfigActions()
Retourne une référence vers la configuration des actions |
Action |
getCurrentAction()
Action en cours |
org.jasig.portal.ChannelCacheKey |
getDefaultCacheKey()
Retourne la clé par défaut du cache pour l'action en cours |
boolean |
getDefaultCacheValid(java.lang.Object validity)
|
java.lang.String |
getPrefForm()
Retourne l'identifiant à utiliser dans les pages html pour les noms d'objets |
java.lang.String |
getPrefParam(java.lang.String param)
Permet de rendre unique un nom de paramètre en le préfixant par l'identifiant unique de la classe |
Action |
getPreviousAction()
Action précédente |
java.lang.Object[] |
getServantResults()
Donne le résultat du servant |
org.jasig.portal.ChannelStaticData |
getStaticData()
Retourne les staticData de la channel principale |
void |
initServant(org.jasig.portal.IServant servant)
Initialisation du servant Cette méthode est appellée par ServantFactory juste après l'instanciation du servant. |
boolean |
isCacheValid(java.lang.Object validity)
|
boolean |
isCurrentAction(java.lang.String actionName)
Permet de tester si l'action en cours est celle dont le nom est passé en paramètre |
boolean |
isInCache()
Indique si le cache est actif |
void |
logConfigActions()
Loggue les actions de la channel dans le log uPortal |
void |
logParams()
Loggue les paramètres runtimeData reçus par la MainChannel A retrouver dans le log principale uPortal |
void |
redirect(org.jasig.portal.ChannelRuntimeData rd,
java.lang.String action)
Effectue une "redirection" depuis une action vers une autre Attention : cette redirection ne peut-être faite que dans les méthode init, setXML ou setOutput!!! |
void |
renderXML(org.xml.sax.ContentHandler out)
Rendu XML/XSLT de la channel principale qui consiste en une déléguation du rendu soit à la sous-channel en cours soit au servant en cours La MainChannel n'effectue pas de rendu propre. |
void |
setConfigActions(IConfigActions actions)
Positionne la référence vers la configuration des actions |
void |
setRuntimeData(org.jasig.portal.ChannelRuntimeData rd)
Positionnement des RuntimeData Il s'agit du "coeur" du processus qui va soit : - Instancier(ou réutiliser) une sous-channel et lancer son cycle de vie : init/setXML/setOutput - Instancier un servant ou passer la main au servant déjà instancié |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.IChannel |
getRuntimeProperties, receiveEvent, setStaticData |
Constructor Detail |
public MainChannel()
Method Detail |
public void setRuntimeData(org.jasig.portal.ChannelRuntimeData rd) throws org.jasig.portal.PortalException
setRuntimeData
in interface org.jasig.portal.IChannel
rd
- Les runtimeData fourni par le socle uPortal
org.jasig.portal.PortalException
public void calcCurrentAction(org.jasig.portal.ChannelRuntimeData rd) throws org.jasig.portal.PortalException
rd
- runtimeData de la channel principale
org.jasig.portal.PortalException
public void renderXML(org.xml.sax.ContentHandler out) throws org.jasig.portal.PortalException
renderXML
in interface org.jasig.portal.IChannel
out
-
org.jasig.portal.PortalException
public void redirect(org.jasig.portal.ChannelRuntimeData rd, java.lang.String action) throws org.jasig.portal.PortalException
rd
- runtimeData à utiliser pour la nouvelle actionaction
- action vers laquelle se rediriger
org.jasig.portal.PortalException
public void initServant(org.jasig.portal.IServant servant) throws org.jasig.portal.PortalException
servant
- le servant à initialiser
org.jasig.portal.PortalException
public boolean isCurrentAction(java.lang.String actionName)
actionName
- nom de l'action à comparer à celui de l'action en cours
public IConfigActions getConfigActions()
public void setConfigActions(IConfigActions actions)
actions
- public Action getCurrentAction()
public Action getPreviousAction()
public java.lang.Object[] getServantResults()
public void logParams()
public void logConfigActions()
public void clearChannelsMap()
public java.lang.String getPrefForm()
public java.lang.String getPrefParam(java.lang.String param)
param
- nom du paramètre
public void clearServantResults()
public org.jasig.portal.ChannelStaticData getStaticData()
public boolean isInCache()
public org.jasig.portal.ChannelCacheKey generateKey()
generateKey
in interface org.jasig.portal.ICacheable
public boolean isCacheValid(java.lang.Object validity)
isCacheValid
in interface org.jasig.portal.ICacheable
public org.jasig.portal.ChannelCacheKey getDefaultCacheKey()
public boolean getDefaultCacheValid(java.lang.Object validity)
validity
-
|
channels 1.0 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |