Package org.ametys.plugins.forms.workflow

Class AbstractFormDashboardGenerator

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.xml.AbstractXMLProducer

org.apache.cocoon.generation.AbstractGenerator

org.apache.cocoon.generation.ServiceableGenerator

org.ametys.plugins.forms.workflow.AbstractFormDashboardGenerator

All Implemented Interfaces:

Poolable, Recyclable, Disposable, Component, LogEnabled, Serviceable, Generator, SitemapModelComponent, XMLProducer

Direct Known Subclasses:

FormDashboardGenerator

public abstract class AbstractFormDashboardGenerator
extends ServiceableGenerator

This class generates all the forms process information for current user

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected UserHelper	_userHelper	The user helper
protected WorkflowHelper	_workflowHelper	The workflow helper component
protected WorkflowHistoryHelper	_workflowHistoryHelper	The ametys object resolver

Fields inherited from class org.apache.cocoon.generation.ServiceableGenerator

manager

Fields inherited from class org.apache.cocoon.generation.AbstractGenerator

objectModel, parameters, resolver, source

Fields inherited from class org.apache.cocoon.xml.AbstractXMLProducer

contentHandler, EMPTY_CONTENT_HANDLER, lexicalHandler, xmlConsumer

Fields inherited from interface org.apache.cocoon.generation.Generator

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractFormDashboardGenerator()

Method Summary

Modifier and Type	Method	Description
protected abstract List<Answer>	_getAnswers(String siteName, String lang, UserIdentity user)	Get the list of answers to sax
protected abstract com.opensymphony.workflow.Workflow	_getWorkflow()	Get the workflow of answer
protected void	_saxWorkflowInformations(Answer answer, UserIdentity user)	Sax the workflow informations
void	generate()
void	service(ServiceManager smanager)

Methods inherited from class org.apache.cocoon.generation.ServiceableGenerator

dispose

Methods inherited from class org.apache.cocoon.generation.AbstractGenerator

recycle, setup

Methods inherited from class org.apache.cocoon.xml.AbstractXMLProducer

setConsumer, setContentHandler, setLexicalHandler

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cocoon.xml.XMLProducer

setConsumer

Field Details

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_workflowHistoryHelper

protected WorkflowHistoryHelper _workflowHistoryHelper

The ametys object resolver

_workflowHelper

protected WorkflowHelper _workflowHelper

The workflow helper component

_userHelper

protected UserHelper _userHelper

The user helper

Constructor Details

AbstractFormDashboardGenerator

public AbstractFormDashboardGenerator()

Method Details

service

public void service(ServiceManager smanager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class ServiceableGenerator

Throws:

ServiceException

generate

public void generate()
              throws IOException,
SAXException,
ProcessingException

Throws:

IOException

SAXException

ProcessingException

_getAnswers

protected abstract List<Answer> _getAnswers(String siteName,
 String lang,
 UserIdentity user)
                                     throws FormsException

Get the list of answers to sax

Parameters:

siteName - the site name

lang - the lang

user - the user

Returns:

the list of common answer

Throws:

FormsException - if a form error occurred

_getWorkflow

protected abstract com.opensymphony.workflow.Workflow _getWorkflow()

Get the workflow of answer

Returns:

the workflow

_saxWorkflowInformations

protected void _saxWorkflowInformations(Answer answer,
 UserIdentity user)
                                 throws Exception

Sax the workflow informations

Parameters:

answer - the answer

user - the user

Throws:

Exception - if an error occurred