fr.toutatice.portail.cms.nuxeo.api.forms

Interface IFormsService

public interface IFormsService

Forms service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTOR_GROUP_PREFIX Nuxeo task actor group prefix.
static String	ACTOR_USER_PREFIX Nuxeo task actor user prefix.
static String	DELETE_ON_ENDING_PARAMETER Delete on workflow ending parameter.
static String	ENDSTEP End step name.
static String	FORM_STEP_REFERENCE step reference holding default form
static String	FORMS_WEB_ID_PREFIX Forms webId prefix.
static String	REDIRECT_CMS_PATH_PARAMETER parameter holding cms path to redirect to
static String	REDIRECT_DISPLAYCONTEXT_PARAMETER parameter holding displayContext to redirect with
static String	REDIRECT_MESSAGE_PARAMETER parameter holding notification message after redirection

Method Summary

Modifier and Type	Method and Description
String	convertToJson(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, Object object) Convert object to JSON string value.
String	convertVariablesToJson(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, Map<String,String> variables) Convert variables map to JSON string value.
Map<String,String>	getUploadedFilesVariables(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles) Get uploaded files variables map.
Map<String,String>	init(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document document, Map<String,String> variables) Execute initialisation of a form retrieves properties from the parent model when necessary
Map<String,String>	proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document task, Map<String,String> variables) Proceed with default action.
Map<String,String>	proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.Document task, String actionId, Map<String,String> variables) Proceed.
Map<String,String>	proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties, Map<String,String> variables) Proceed with default action.
Map<String,String>	proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties, String actionId, Map<String,String> variables) Proceed.
Map<String,String>	proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties, String actionId, Map<String,String> variables, Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles) Proceed.
Map<String,String>	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String modelWebId, Map<String,String> variables) Start with default action.
Map<String,String>	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String modelWebId, String actionId, Map<String,String> variables) Start.
Map<String,String>	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String modelWebId, String actionId, Map<String,String> variables, Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles) Start.
String	transform(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String expression, org.nuxeo.ecm.automation.client.model.Document task) Tranform expression with Expression-Language resolver.
String	transform(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String expression, Map<String,String> variables) Tranform expression with Expression-Language resolver.

Field Detail

FORMS_WEB_ID_PREFIX

static final String FORMS_WEB_ID_PREFIX

Forms webId prefix.

See Also:

Constant Field Values

ENDSTEP

static final String ENDSTEP

End step name.

See Also:

Constant Field Values

DELETE_ON_ENDING_PARAMETER

static final String DELETE_ON_ENDING_PARAMETER

Delete on workflow ending parameter.

See Also:

Constant Field Values

REDIRECT_CMS_PATH_PARAMETER

static final String REDIRECT_CMS_PATH_PARAMETER

parameter holding cms path to redirect to

See Also:

Constant Field Values

REDIRECT_DISPLAYCONTEXT_PARAMETER

static final String REDIRECT_DISPLAYCONTEXT_PARAMETER

parameter holding displayContext to redirect with

See Also:

Constant Field Values

REDIRECT_MESSAGE_PARAMETER

static final String REDIRECT_MESSAGE_PARAMETER

parameter holding notification message after redirection

See Also:

Constant Field Values

ACTOR_USER_PREFIX

static final String ACTOR_USER_PREFIX

Nuxeo task actor user prefix.

See Also:

Constant Field Values

ACTOR_GROUP_PREFIX

static final String ACTOR_GROUP_PREFIX

Nuxeo task actor group prefix.

See Also:

Constant Field Values

FORM_STEP_REFERENCE

static final String FORM_STEP_REFERENCE

step reference holding default form

See Also:

Constant Field Values

Method Detail

start

Map<String,String> start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                         String modelWebId,
                         Map<String,String> variables)
                  throws org.osivia.portal.api.PortalException,
                         FormFilterException

Start with default action.

Parameters:

portalControllerContext - portal controller context

modelWebId - model webId

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

start

Map<String,String> start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                         String modelWebId,
                         String actionId,
                         Map<String,String> variables)
                  throws org.osivia.portal.api.PortalException,
                         FormFilterException

Start.

Parameters:

portalControllerContext - portal controller context

modelWebId - model webId

actionId - action identifier

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

start

Map<String,String> start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                         String modelWebId,
                         String actionId,
                         Map<String,String> variables,
                         Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles)
                  throws org.osivia.portal.api.PortalException,
                         FormFilterException

Start.

Parameters:

portalControllerContext - portal controller context

modelWebId - model webId

actionId - action identifier

variables - variables

uploadedFiles - uploaded files

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

proceed

Map<String,String> proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           org.nuxeo.ecm.automation.client.model.Document task,
                           Map<String,String> variables)
                    throws org.osivia.portal.api.PortalException,
                           FormFilterException

Proceed with default action.

Parameters:

portalControllerContext - portal controller context

task - task document

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

proceed

Map<String,String> proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           org.nuxeo.ecm.automation.client.model.Document task,
                           String actionId,
                           Map<String,String> variables)
                    throws org.osivia.portal.api.PortalException,
                           FormFilterException

Proceed.

Parameters:

portalControllerContext - portal controller context

task - task document

actionId - action identifier

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

proceed

Map<String,String> proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties,
                           Map<String,String> variables)
                    throws org.osivia.portal.api.PortalException,
                           FormFilterException

Proceed with default action.

Parameters:

portalControllerContext - portal controller context

taskProperties - task properties

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

proceed

Map<String,String> proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties,
                           String actionId,
                           Map<String,String> variables)
                    throws org.osivia.portal.api.PortalException,
                           FormFilterException

Proceed.

Parameters:

portalControllerContext - portal controller context

taskProperties - task properties

actionId - action identifier

variables - variables

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

proceed

Map<String,String> proceed(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           org.nuxeo.ecm.automation.client.model.PropertyMap taskProperties,
                           String actionId,
                           Map<String,String> variables,
                           Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles)
                    throws org.osivia.portal.api.PortalException,
                           FormFilterException

Proceed.

Parameters:

portalControllerContext - portal controller context

taskProperties - task properties

actionId - action identifier

variables - variables

uploadedFiles - uploaded files

Returns:

updated variables

Throws:

org.osivia.portal.api.PortalException

FormFilterException

transform

String transform(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                 String expression,
                 org.nuxeo.ecm.automation.client.model.Document task)
          throws org.osivia.portal.api.PortalException

Tranform expression with Expression-Language resolver.

Parameters:

portalControllerContext - portal controller context

expression - expression

task - task document

Returns:

transformed expression

Throws:

org.osivia.portal.api.PortalException

transform

String transform(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                 String expression,
                 Map<String,String> variables)
          throws org.osivia.portal.api.PortalException

Tranform expression with Expression-Language resolver.

Parameters:

portalControllerContext - portal controller context

expression - expression

variables - task variables

Returns:

transformed expression

Throws:

org.osivia.portal.api.PortalException

init

Map<String,String> init(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                        org.nuxeo.ecm.automation.client.model.Document document,
                        Map<String,String> variables)
                 throws org.osivia.portal.api.PortalException,
                        FormFilterException

Execute initialisation of a form retrieves properties from the parent model when necessary

Parameters:

portalControllerContext -

document -

variables -

Returns:

variables updated by init filters

Throws:

org.osivia.portal.api.PortalException

FormFilterException

getUploadedFilesVariables

Map<String,String> getUploadedFilesVariables(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                             Map<String,org.osivia.portal.api.portlet.model.UploadedFile> uploadedFiles)
                                      throws org.osivia.portal.api.PortalException

Get uploaded files variables map.

Parameters:

portalControllerContext - portal controller context

uploadedFiles - uploaded files

Returns:

variables map

Throws:

org.osivia.portal.api.PortalException

convertToJson

String convertToJson(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                     Object object)
              throws org.osivia.portal.api.PortalException

Convert object to JSON string value.

Parameters:

portalControllerContext - portal controller context

object - object

Returns:

JSON string value

Throws:

org.osivia.portal.api.PortalException

convertVariablesToJson

String convertVariablesToJson(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                              Map<String,String> variables)
                       throws org.osivia.portal.api.PortalException

Convert variables map to JSON string value.

Parameters:

portalControllerContext - portal controller context

variables - variables map

Returns:

JSON string value

Throws:

org.osivia.portal.api.PortalException