fr.natsystem.natjet.application

Class NsWorkFlow

java.lang.Object

fr.natsystem.natjet.application.NsWorkFlow

All Implemented Interfaces:

INsWorkFlowDataProvider, fr.natsystem.natjetinternal.application.IPvWorkFlow, Serializable

@NsCopyright
public class NsWorkFlow
extends Object
implements fr.natsystem.natjetinternal.application.IPvWorkFlow, Serializable

Classe de gestion de l'enchainement des vues (WorkFlow) dans une application NatJet

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
NsWorkFlow() Constructeur par défaut afin de pouvoir sérialiser la classe
NsWorkFlow(String views, List<String> flows) Deprecated. Remplacé par une définition des vues et des flux dans un descripteur Spring nsflows.xml.
NsWorkFlow(String views, String flow) Deprecated. Remplacé par une définition des vues et des flux dans un descripteur Spring nsflows.xml.

Method Summary

Modifier and Type	Method and Description
static void	addGlobalTransitionListener(String globalTransitionName, INsFireableListener listener) Adds a Global transition listener (eg. it does not work on local transitions) to a transition name.
static void	addGlobalTransitionsListener(INsFireableListener<NsWorkFlowFormEvent> listener) Place a listener on all transitions that happen in the workflow system.
Map<String,?>	getFlowData() Lecture de la map du modèle de WorkFlow
static Map<String,?>	getModel() Deprecated. Méthode remplacée par getFlowData()
static NsWorkFlow	getWorkFlow() Lecture de l'instance de NsWorkFlow dans l'instance d'application
Class<? extends NsFormEvent>	getWorkFlowFormEvent()
static void	init() Initialisation du WorkFlow de l'application.
static void	init(String initialFlowId, Object data) Initialisation du WorkFlow de l'application
static void	init(String initialFlowId, String initialViewState, Object data) Initialisation du WorkFlow de l'application
boolean	internalNext(String transition, Object data, Integer userTag, Object parameters, INsWorkFlowable.TransitionType transitionType) Sortie d'un état du WorkFlow via une transition
boolean	internalResumeNext(NsForm form, boolean finalizeClose) Reprise de la sortie d'un état du WorkFlow via une transition après interruption par le processus de remplacement des panneaux
void	internalSetModel(Map<String,?> model)
void	internalTerminateNext()
static boolean	next(String transition, Object data, Integer userTag) Sortie d'un état du WorkFlow via une transition
static boolean	next(String transition, Object data, Integer userTag, Object parameters) Sortie d'un état du WorkFlow via une transition
static void	removeGlobalTransitionListener(INsFireableListener<NsWorkFlowFormEvent> listener, String transition) Removes the transition listener attached to the given transition name if the transition listener does not exist among the registered listeners, the method does not fail
static void	removeGlobalTransitionsListener(INsFireableListener<NsWorkFlowFormEvent> listener) Removes the global listener from the registered all-transitions listeners.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NsWorkFlow

public NsWorkFlow()

Constructeur par défaut afin de pouvoir sérialiser la classe

NsWorkFlow

@Deprecated
public NsWorkFlow(String views,
                               String flow)

Deprecated. Remplacé par une définition des vues et des flux dans un descripteur Spring nsflows.xml.

Construction du WorkFlow de l'application

Parameters:

views - Fichier XML de description des vues de l'application

flow - Fichier XML de description des états et transitions de l'application

NsWorkFlow

@Deprecated
public NsWorkFlow(String views,
                               List<String> flows)

Deprecated. Remplacé par une définition des vues et des flux dans un descripteur Spring nsflows.xml.

Construction du WorkFlow de l'application

Parameters:

views - Fichier XML de description des vues de l'application

flows - Fichiers XML de description des états et transitions de l'application

Method Detail

init

public static void init()

Initialisation du WorkFlow de l'application.

La vue initiale de l'application est définie par l'état initial du WorkFlow.

L'état initial du WorkFlow est décrit dans le fichier des flux sur la propriété start-state de la balise flow ou à défaut comme étant le premier état décrit dans le fichier des flux.

La vue initiale est indiquée dans le fichier des flux sur la propriété view de la balise view-state ou à défaut sur la propriété id de l'état initial.

init

public static void init(String initialFlowId,
                        Object data)

Initialisation du WorkFlow de l'application

Parameters:

initialFlowId - Identifiant du flux principal (nom de base du fichier webflow)

data - Données d'initialisation des formes de la vue destination.

init

public static void init(String initialFlowId,
                        String initialViewState,
                        Object data)

Initialisation du WorkFlow de l'application

Parameters:

initialFlowId - Identifiant du flux principal (nom de base du fichier webflow)

initialViewState - Vue initiale de l'application

data - Données d'initialisation des formes de la vue destination.

next

public static boolean next(String transition,
                           Object data,
                           Integer userTag)

Sortie d'un état du WorkFlow via une transition

Parameters:

transition - Identifiant de la transition telle que définie dans les fichiers de flux.

data - Données d'initialisation des formes de la vue destination.

userTag - Identifiant du processus de transition. Cet identifiant est disponible dans les évènements NsReplacedFormEvent, NsBeforeCloseFormEvent et NsWorkFlowFormEvent.

Returns:

Succès ou échec de l'opération.

next

public static boolean next(String transition,
                           Object data,
                           Integer userTag,
                           Object parameters)

Sortie d'un état du WorkFlow via une transition

Parameters:

transition - Identifiant de la transition telle que définie dans les fichiers de flux.

data - Données d'initialisation des formes de la vue destination.

userTag - Identifiant du processus de transition. Cet identifiant est disponible dans les évènements NsReplacedFormEvent, NsBeforeCloseFormEvent et NsWorkFlowFormEvent.

parameters - Paramètres de la transition

Returns:

Succès ou échec de l'opération.

getWorkFlowFormEvent

public Class<? extends NsFormEvent> getWorkFlowFormEvent()

Specified by:

getWorkFlowFormEvent in interface fr.natsystem.natjetinternal.application.IPvWorkFlow

internalNext

@NsInternalOnly
public boolean internalNext(String transition,
                                             Object data,
                                             Integer userTag,
                                             Object parameters,
                                             INsWorkFlowable.TransitionType transitionType)

Sortie d'un état du WorkFlow via une transition

Specified by:

internalNext in interface fr.natsystem.natjetinternal.application.IPvWorkFlow

Parameters:

transition - Transition à effectuer

data - Données d'initialisation des formes de la vue destination.

userTag - Identifiant utilisateur du processus de remplacement des panneaux. Cet identifiant est disponible dans les évènements NsReplacedFormEvent, NsBeforeCloseFormEvent et NsWorkFlowFormEvent.

Returns:

Succès ou échec de l'opération.

internalResumeNext

@NsInternalOnly
public boolean internalResumeNext(NsForm form,
                                                   boolean finalizeClose)

Reprise de la sortie d'un état du WorkFlow via une transition après interruption par le processus de remplacement des panneaux

Specified by:

internalResumeNext in interface fr.natsystem.natjetinternal.application.IPvWorkFlow

Parameters:

form - Form ayant déclenché l'interruption

finalizeClose - Reprise de la transition (true) ou arrêt de la transition (false)

Returns:

Succès ou échec de l'opération

internalSetModel

@NsInternalOnly
public void internalSetModel(Map<String,?> model)

internalTerminateNext

@NsInternalOnly
public void internalTerminateNext()

getFlowData

public Map<String,?> getFlowData()

Lecture de la map du modèle de WorkFlow

Specified by:

getFlowData in interface INsWorkFlowDataProvider

Returns:

Map du modèle de WorkFlow

getModel

@Deprecated
public static Map<String,?> getModel()

Deprecated. Méthode remplacée par getFlowData()

Lecture de la map du modèle de WorkFlow

Returns:

Map du modèle de WorkFlow

getWorkFlow

public static NsWorkFlow getWorkFlow()

Lecture de l'instance de NsWorkFlow dans l'instance d'application

Returns:

Instance du workflow dans l'application

addGlobalTransitionListener

public static void addGlobalTransitionListener(String globalTransitionName,
                                               INsFireableListener listener)

Adds a Global transition listener (eg. it does not work on local transitions) to a transition name. So every time the transition occurs, the INsFireableListener.triggerEvent(fr.natsystem.natjet.event.NsEvent) is executed.

Parameters:

globalTransitionsNames - A list of transitions on which the listener should be attached

listener - The listener to add in the registered listeners

addGlobalTransitionsListener

public static void addGlobalTransitionsListener(INsFireableListener<NsWorkFlowFormEvent> listener)

Place a listener on all transitions that happen in the workflow system. Beware the listener INsFireableListener.triggerEvent(fr.natsystem.natjet.event.NsEvent) will be triggered for each transition in the

Parameters:

listener - The listener to be registered on every transition in the workflow system

removeGlobalTransitionsListener

public static void removeGlobalTransitionsListener(INsFireableListener<NsWorkFlowFormEvent> listener)

Removes the global listener from the registered all-transitions listeners.

Parameters:

listener - the all-transitions listener to be removed

removeGlobalTransitionListener

public static void removeGlobalTransitionListener(INsFireableListener<NsWorkFlowFormEvent> listener,
                                                  String transition)

Removes the transition listener attached to the given transition name if the transition listener does not exist among the registered listeners, the method does not fail

Parameters:

listener - the listener to remove

transition - the transition on which the listener is currently attached