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	FORMS_WEB_ID_PREFIX Forms webId prefix.

Method Summary

Methods

Modifier and Type	Method and Description
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>	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String modelId, Map<String,String> variables) Start with default action.
Map<String,String>	start(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String modelId, String actionId, Map<String,String> variables) 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

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

Method Detail

start

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

Start with default action.

Parameters:

portalControllerContext - portal controller context

modelId - model 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 modelId,
                       String actionId,
                       Map<String,String> variables)
                         throws org.osivia.portal.api.PortalException,
                                FormFilterException

Start.

Parameters:

portalControllerContext - portal controller context

modelId - model identifier

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.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

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