channels 1.0
API Documentation

org.esupportail.portal.utils.channels
Class Action

java.lang.Object
  extended byorg.esupportail.portal.utils.channels.Action

public class Action
extends java.lang.Object

Action

Cette classe décrit une action que peut effectuer la channel
Les actions de la channel sont référencées dans une haspmap accessible à partir de l'objet configActions de la classe principale du channel.
Les actions sont lues à partir du fichier de configuration de la channel.

(c)Copyright ESup-Portail 2004

Version:
1.0
Author:
Olivier Ziller

Field Summary
static java.lang.String CHANNEL_CACHE_TYPE
           
static java.lang.String DEFAULT_CACHE_TYPE
           
static java.lang.String INSTANCE_CACHE_TYPE
           
static java.lang.String RENDER_TYPE_SSL
           
static java.lang.String RENDER_TYPE_XSL
           
 
Constructor Summary
Action()
           
 
Method Summary
 java.lang.String getCachetype()
          Le type de cache
 java.lang.String getClassname()
          Le nom complet de la classe à instancier pour l'action (DOIT ETRE UNIQUE pour une channel)
 java.lang.String getInit()
          Le nom de la méthode d'initialisation de l'action (init par défaut)
 java.lang.String getName()
          Le nom de l'action
 java.lang.Object getParam()
          Le paramètre associé à l'action
 java.lang.String getRenderType()
          Le type de rendu de l'action : xsl ou ssl (xsl par défaut)
 java.lang.String getRenderXML()
          Le nom de la méthode qui fait le rendu XML pour l'action (renderXML par défaut)
 java.lang.String getServantfinish()
          Le nom de l'action à initier lorsque le servant est terminé
 java.lang.String getSetOutput()
          Le nom de la méthode qui fixe les paramètres de rendu xml (setOutput par défaut)
 java.lang.String getSetXML()
          Le nom de la méthode qui fixe le XML pour le rendu (setXML par défaut)
 java.lang.String getSslFile()
          Le nom du fichier ssl à utiliser lorsque l'action est du type ssl (null par défaut)
 java.lang.String getSslTitle()
          Le "title" à utiliser dans la feuille ssl lorsque l'action est du type ssl
 java.lang.String getType()
          Le type de l'action (normal ou servant / normal par défaut)
 java.lang.String getXslFile()
          Le nom du fichier xsl à utiliser lorsque l'action est du type xsl (par défaut getName() + ".xsl")
 boolean isServant()
          Indique si l'action en cours est un servant
 void setCachetype(java.lang.String cachetype)
          Positionne le type de cache
 void setClassname(java.lang.String string)
          Positionnement du nom de la classe de l'action
 void setInit(java.lang.String string)
          Positionnement de la méthode d'initialisation de l'action
 void setName(java.lang.String string)
          Positionnement du nom de l'action
 void setParam(java.lang.Object param)
          Positionne le paramètre associé à l'action
 void setRendertype(java.lang.String string)
          Positionnement du type de rendu de l'action
 void setRenderxml(java.lang.String string)
          Positionnement du nom de la méthode qui assure le rendu XML pour l'action
 void setServantfinish(java.lang.String string)
          Positionnement du nom l'action à initier lorsque le servant est terminé
 void setSetoutput(java.lang.String string)
          Positionnement du nom de la méthode qui fixe les paramètres de rendu XML
 void setSetxml(java.lang.String string)
          Positionnement du XML à utiliser dans la transformation XSLT
 void setSslfile(java.lang.String string)
          Positionnement du nom du fichier ssl
 void setSsltitle(java.lang.String string)
          Positionnement du title à utiliser dans la feuille ssl
 void setType(java.lang.String string)
          Positionnement du type de l'action (normal ou servant)
 void setXslfile(java.lang.String string)
          Positionnement du nom du fichier xsl
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RENDER_TYPE_SSL

public static final java.lang.String RENDER_TYPE_SSL
See Also:
Constant Field Values

RENDER_TYPE_XSL

public static final java.lang.String RENDER_TYPE_XSL
See Also:
Constant Field Values

DEFAULT_CACHE_TYPE

public static final java.lang.String DEFAULT_CACHE_TYPE
See Also:
Constant Field Values

INSTANCE_CACHE_TYPE

public static final java.lang.String INSTANCE_CACHE_TYPE
See Also:
Constant Field Values

CHANNEL_CACHE_TYPE

public static final java.lang.String CHANNEL_CACHE_TYPE
See Also:
Constant Field Values
Constructor Detail

Action

public Action()
Method Detail

getName

public java.lang.String getName()
Le nom de l'action

Returns:
Le nom de l'action

getType

public java.lang.String getType()
Le type de l'action (normal ou servant / normal par défaut)

Returns:
Le type de l'action (normal ou servant / normal par défaut)

getClassname

public java.lang.String getClassname()
Le nom complet de la classe à instancier pour l'action (DOIT ETRE UNIQUE pour une channel)

Returns:
Le nom complet de la classe à instancier pour l'action (DOIT ETRE UNIQUE pour une channel)

getInit

public java.lang.String getInit()
Le nom de la méthode d'initialisation de l'action (init par défaut)

Returns:
Le nom de la méthode d'initialisation de l'action (init par défaut)

getRenderType

public java.lang.String getRenderType()
Le type de rendu de l'action : xsl ou ssl (xsl par défaut)

Returns:
Le type de rendu de l'action : xsl ou ssl (xsl par défaut)

getRenderXML

public java.lang.String getRenderXML()
Le nom de la méthode qui fait le rendu XML pour l'action (renderXML par défaut)

Returns:
Le nom de la méthode qui fait le rendu XML pour l'action (renderXML par défaut)

getSetOutput

public java.lang.String getSetOutput()
Le nom de la méthode qui fixe les paramètres de rendu xml (setOutput par défaut)

Returns:
Le nom de la méthode qui fixe les paramètres de rendu xml (setOutput par défaut)

getSetXML

public java.lang.String getSetXML()
Le nom de la méthode qui fixe le XML pour le rendu (setXML par défaut)

Returns:
Le nom de la méthode qui fixe le XML pour le rendu (setXML par défaut)

getSslFile

public java.lang.String getSslFile()
Le nom du fichier ssl à utiliser lorsque l'action est du type ssl (null par défaut)

Returns:
Le nom du fichier ssl à utiliser lorsque l'action est du type ssl (null par défaut)

getSslTitle

public java.lang.String getSslTitle()
Le "title" à utiliser dans la feuille ssl lorsque l'action est du type ssl

Returns:
Le "title" à utiliser dans la feuille ssl lorsque l'action est du type ssl

getXslFile

public java.lang.String getXslFile()
Le nom du fichier xsl à utiliser lorsque l'action est du type xsl (par défaut getName() + ".xsl")

Returns:
Le nom du fichier xsl à utiliser lorsque l'action est du type xsl (par défaut getName() + ".xsl")

getServantfinish

public java.lang.String getServantfinish()
Le nom de l'action à initier lorsque le servant est terminé

Returns:
Le nom de l'action à initier lorsque le servant est terminé

getParam

public java.lang.Object getParam()
Le paramètre associé à l'action

Returns:
le paramètre associé à l'action

getCachetype

public java.lang.String getCachetype()
Le type de cache

Returns:

setClassname

public void setClassname(java.lang.String string)
Positionnement du nom de la classe de l'action

Parameters:
string -

setInit

public void setInit(java.lang.String string)
Positionnement de la méthode d'initialisation de l'action

Parameters:
string -

setName

public void setName(java.lang.String string)
Positionnement du nom de l'action

Parameters:
string -

setRendertype

public void setRendertype(java.lang.String string)
Positionnement du type de rendu de l'action

Parameters:
string -

setRenderxml

public void setRenderxml(java.lang.String string)
Positionnement du nom de la méthode qui assure le rendu XML pour l'action

Parameters:
string -

setSetoutput

public void setSetoutput(java.lang.String string)
Positionnement du nom de la méthode qui fixe les paramètres de rendu XML

Parameters:
string -

setSetxml

public void setSetxml(java.lang.String string)
Positionnement du XML à utiliser dans la transformation XSLT

Parameters:
string -

setSslfile

public void setSslfile(java.lang.String string)
Positionnement du nom du fichier ssl

Parameters:
string -

setSsltitle

public void setSsltitle(java.lang.String string)
Positionnement du title à utiliser dans la feuille ssl

Parameters:
string -

setXslfile

public void setXslfile(java.lang.String string)
Positionnement du nom du fichier xsl

Parameters:
string -

setServantfinish

public void setServantfinish(java.lang.String string)
Positionnement du nom l'action à initier lorsque le servant est terminé

Parameters:
string -

setType

public void setType(java.lang.String string)
Positionnement du type de l'action (normal ou servant)

Parameters:
string -

isServant

public boolean isServant()
Indique si l'action en cours est un servant

Returns:

setParam

public void setParam(java.lang.Object param)
Positionne le paramètre associé à l'action


setCachetype

public void setCachetype(java.lang.String cachetype)
Positionne le type de cache


channels 1.0
API Documentation