de.hybris.platform.xyformsweb.controllers.integration

Class OrbeonFormController

java.lang.Object

de.hybris.platform.xyformsweb.controllers.integration.AbstractController

de.hybris.platform.xyformsweb.controllers.integration.OrbeonFormController

public class OrbeonFormController
extends AbstractController

OrbeonFormController Integration for Orbeon Persistence API Use for providing Create, Read, Update and delete services for integrated Orbeon functions. This will also handle Search and other Orbeon provided functions.

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.xyformsweb.controllers.integration.AbstractController

AbstractController.HttpNotFoundException

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	FORM_BUILDER_NEXT_VERSION
protected static java.lang.String	FR_SERVICE_RESOURCE_PREFIX
protected static Logger	LOG
protected static java.lang.String	ORBEON_FORM_DEFINITION_VERSION
protected static java.lang.String	SEARCH_FORMDATA_EMPTY_SET
protected static java.lang.String	SEARCH_FORMDEFINITIONS_RESPONSE

Fields inherited from class de.hybris.platform.xyformsweb.controllers.integration.AbstractController

FORWARD_PREFIX, REDIRECT_PREFIX, ROOT

Constructor Summary

Constructors

Constructor and Description
OrbeonFormController()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormDataData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, HttpServletResponse response) Retrieves the DATA version of a form data.
java.lang.String	getFormDataDraft(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, HttpServletResponse response) Retrieves the DRAFT version of a form data.
java.lang.String	getFormDefinition(java.lang.String applicationId, java.lang.String formId, java.lang.String documentId, HttpServletResponse response) Get yForm Definition.
protected java.lang.String	getSearchFormDefinitionBody(java.lang.String applicationId, java.lang.String formId)
void	putFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataType, java.lang.String formDataId, HttpServletRequest request, HttpServletResponse response) Saves the amend form data back to the database.
void	putFormDefinition(java.lang.String applicationId, java.lang.String formId, java.lang.String documentId, HttpServletRequest request, HttpServletResponse response) Put Form Definition.
void	searchFormData(java.lang.String applicationId, java.lang.String formId, HttpServletRequest request, HttpServletResponse response) Search for form data, no actual implementation yet, only returns an empty xml, this to minimize error logs on the orbeon side.
void	searchFormDefinitions(HttpServletRequest request, HttpServletResponse response) Search for form definitions, no actual implementation yet, only returns an empty xml, this to minimize error logs on the orbeon side.

Methods inherited from class de.hybris.platform.xyformsweb.controllers.integration.AbstractController

addRequestToModel, getBean

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

FR_SERVICE_RESOURCE_PREFIX

protected static final java.lang.String FR_SERVICE_RESOURCE_PREFIX

See Also:

Constant Field Values

ORBEON_FORM_DEFINITION_VERSION

protected static final java.lang.String ORBEON_FORM_DEFINITION_VERSION

See Also:

Constant Field Values

FORM_BUILDER_NEXT_VERSION

protected static final java.lang.String FORM_BUILDER_NEXT_VERSION

See Also:

Constant Field Values

SEARCH_FORMDATA_EMPTY_SET

protected static final java.lang.String SEARCH_FORMDATA_EMPTY_SET

See Also:

Constant Field Values

SEARCH_FORMDEFINITIONS_RESPONSE

protected static final java.lang.String SEARCH_FORMDEFINITIONS_RESPONSE

See Also:

Constant Field Values

Constructor Detail

OrbeonFormController

public OrbeonFormController()

Method Detail

getFormDefinition

public java.lang.String getFormDefinition(java.lang.String applicationId,
                                          java.lang.String formId,
                                          java.lang.String documentId,
                                          HttpServletResponse response)
                                   throws ServletException,
                                          java.io.IOException,
                                          YFormServiceException

Get yForm Definition.
On passing in the applicationId and the formId will return a form.xhtml for the Persistence service call. If documentId is provided then it will return the form definition associated to it. This is valid when dealing with a form definition that has multiple versions.

Parameters:

applicationId -

formId -

documentId -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

putFormDefinition

public void putFormDefinition(java.lang.String applicationId,
                              java.lang.String formId,
                              java.lang.String documentId,
                              HttpServletRequest request,
                              HttpServletResponse response)
                       throws ServletException,
                              java.io.IOException

Put Form Definition.
Publish at the FormBuilder will save the new form definition by calling this service function.

Parameters:

applicationId -

formId -

documentId -

request -

Throws:

ServletException

java.io.IOException

getFormDataDraft

public java.lang.String getFormDataDraft(java.lang.String applicationId,
                                         java.lang.String formId,
                                         java.lang.String formDataId,
                                         HttpServletResponse response)
                                  throws ServletException,
                                         java.io.IOException,
                                         YFormServiceException

Retrieves the DRAFT version of a form data.

Parameters:

applicationId -

formId -

formDataId -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

getFormDataData

public java.lang.String getFormDataData(java.lang.String applicationId,
                                        java.lang.String formId,
                                        java.lang.String formDataId,
                                        HttpServletResponse response)
                                 throws ServletException,
                                        java.io.IOException,
                                        YFormServiceException

Retrieves the DATA version of a form data.

Parameters:

applicationId -

formId -

formDataId -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

putFormData

public void putFormData(java.lang.String applicationId,
                        java.lang.String formId,
                        java.lang.String formDataType,
                        java.lang.String formDataId,
                        HttpServletRequest request,
                        HttpServletResponse response)
                 throws ServletException,
                        java.io.IOException,
                        YFormServiceException

Saves the amend form data back to the database. Creates a new YFormData if it does not exist previously.

Parameters:

applicationId -

formId -

formDataType -

formDataId -

request -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

searchFormData

public void searchFormData(java.lang.String applicationId,
                           java.lang.String formId,
                           HttpServletRequest request,
                           HttpServletResponse response)
                    throws ServletException,
                           java.io.IOException,
                           YFormServiceException

Search for form data, no actual implementation yet, only returns an empty xml, this to minimize error logs on the orbeon side.

This method is also called when versioning is enabled and the query is as follows:

only 10 1 en

When a draft record is found for this document a dialog is shown to the user to make a choice, whether to use the DRAFT record or the DATA one.

In this implementation, an empty set is returned and the responsibility to deal with this scenario is for getFormDataData()

Parameters:

applicationId -

formId -

request -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

searchFormDefinitions

public void searchFormDefinitions(HttpServletRequest request,
                                  HttpServletResponse response)
                           throws ServletException,
                                  java.io.IOException,
                                  YFormServiceException

Search for form definitions, no actual implementation yet, only returns an empty xml, this to minimize error logs on the orbeon side.

Parameters:

request -

response -

Throws:

ServletException

java.io.IOException

YFormServiceException

getSearchFormDefinitionBody

protected java.lang.String getSearchFormDefinitionBody(java.lang.String applicationId,
                                                       java.lang.String formId)
                                                throws YFormServiceException

Throws:

YFormServiceException