Package de.hybris.platform.xyformsservices.form.impl

Class DefaultYFormService

java.lang.Object

de.hybris.platform.xyformsservices.form.impl.DefaultYFormService

All Implemented Interfaces:

YFormService

public class DefaultYFormService
extends java.lang.Object
implements YFormService

Implementation of the YFormService for managing yForms.

Constructor Summary

Constructors

Constructor	Description
DefaultYFormService()

Method Summary

Modifier and Type	Method	Description
YFormDataModel	createOrUpdateYFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, YFormDataTypeEnum type, java.lang.String refId, java.lang.String content)	Create or Update YFormDataModel.
YFormDataModel	createYFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, YFormDataTypeEnum type, java.lang.String refId, java.lang.String content)	Create YFormData if no previous exists.
YFormDataModel	createYFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, YFormDataTypeEnum type, java.lang.String refId, java.lang.String content, java.lang.String ownerApplicationId, java.lang.String ownerFormId)	Create YFormData if no previous exists.
YFormDataModel	createYFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String formDataId, YFormDataTypeEnum type, java.lang.String refId, java.lang.String content, java.lang.String ownerApplicationId, java.lang.String ownerFormId, boolean system)	Create YFormData if no previous exists.
YFormDefinitionModel	createYFormDefinition(java.lang.String applicationId, java.lang.String formId, java.lang.String title, java.lang.String description, java.lang.String content, java.lang.String documentId)	Create a new YFormDefinition by the given parameters.
protected GetVersionNumberStrategy	getGetVersionNumberStrategy()
protected ModelService	getModelService()
protected YFormDao	getYFormDao()
YFormDataModel	getYFormData(java.lang.String formDataId, YFormDataTypeEnum type)	For a given id and type a form data is returned.
YFormDataModel	getYFormData(java.lang.String applicationId, java.lang.String formId, java.lang.String refId, YFormDataTypeEnum type)	For the given parameters a YFormDataModel is returned.
java.util.List<YFormDataModel>	getYFormDataByRefId(java.lang.String refId)	For the given refId a list of YFormDataModel is returned.
YFormDefinitionModel	getYFormDefinition(java.lang.String applicationId, java.lang.String formId)	For a given applicationId and formId a form definition is returned.
YFormDefinitionModel	getYFormDefinition(java.lang.String applicationId, java.lang.String formId, int version)	For a given applicationId and formId a form definition is returned.
void	setFormDefinitionStatus(java.lang.String applicationId, java.lang.String formId, YFormDefinitionStatusEnum status)	Set the status for all the form definitions with specific application id and form id.
void	setGetVersionNumberStrategy(GetVersionNumberStrategy getVersionNumberStrategy)
void	setModelService(ModelService modelService)
void	setYFormDao(YFormDao yformDao)
YFormDataModel	updateYFormData(java.lang.String formDataId, YFormDataTypeEnum type, java.lang.String content)	Update YFormData by the given form data id.
YFormDefinitionModel	updateYFormDefinition(java.lang.String applicationId, java.lang.String formId, java.lang.String content, java.lang.String documentId)	Update YFormDefinition if it exists in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultYFormService

public DefaultYFormService()

Method Detail

getYFormDefinition

public YFormDefinitionModel getYFormDefinition(java.lang.String applicationId,
                                               java.lang.String formId)
                                        throws YFormServiceException

For a given applicationId and formId a form definition is returned.

Specified by:

getYFormDefinition in interface YFormService

Parameters:

applicationId -

formId -

Returns:

YFormDefinitionModel

Throws:

YFormServiceException - if definition is not found

getYFormDefinition

public YFormDefinitionModel getYFormDefinition(java.lang.String applicationId,
                                               java.lang.String formId,
                                               int version)
                                        throws YFormServiceException

For a given applicationId and formId a form definition is returned.

Specified by:

getYFormDefinition in interface YFormService

Parameters:

applicationId -

formId -

version -

Returns:

YFormDefinitionModel

Throws:

YFormServiceException - if definition is not found

updateYFormDefinition

public YFormDefinitionModel updateYFormDefinition(java.lang.String applicationId,
                                                  java.lang.String formId,
                                                  java.lang.String content,
                                                  java.lang.String documentId)
                                           throws YFormServiceException

Update YFormDefinition if it exists in the database.
Catch AmbiguousIdentifierException and throws YFormServiceException with corresponding error messages on retrieval from the DAO.

Specified by:

updateYFormDefinition in interface YFormService

Parameters:

applicationId -

formId -

content -

documentId -

Returns:

YFormDefinitionModel

Throws:

ModelNotFoundException

YFormServiceException

createYFormDefinition

@Transactional(propagation=REQUIRED)
public YFormDefinitionModel createYFormDefinition(java.lang.String applicationId,
                                                  java.lang.String formId,
                                                  java.lang.String title,
                                                  java.lang.String description,
                                                  java.lang.String content,
                                                  java.lang.String documentId)
                                           throws YFormServiceException

Create a new YFormDefinition by the given parameters.

Specified by:

createYFormDefinition in interface YFormService

Parameters:

applicationId -

formId -

title -

description -

content -

documentId -

Returns:

YFormDefinitionModel

Throws:

YFormServiceException

getYFormData

public YFormDataModel getYFormData(java.lang.String formDataId,
                                   YFormDataTypeEnum type)
                            throws YFormServiceException

For a given id and type a form data is returned.

Specified by:

getYFormData in interface YFormService

Parameters:

formDataId -

type -

Returns:

YFormDataModel

Throws:

YFormServiceException - if form data is not found

getYFormData

public YFormDataModel getYFormData(java.lang.String applicationId,
                                   java.lang.String formId,
                                   java.lang.String refId,
                                   YFormDataTypeEnum type)
                            throws YFormServiceException

For the given parameters a YFormDataModel is returned.

Specified by:

getYFormData in interface YFormService

Parameters:

applicationId -

formId -

refId -

type -

Returns:

YFormDataModel

Throws:

YFormServiceException

createOrUpdateYFormData

@Transactional(propagation=REQUIRED)
public YFormDataModel createOrUpdateYFormData(java.lang.String applicationId,
                                              java.lang.String formId,
                                              java.lang.String formDataId,
                                              YFormDataTypeEnum type,
                                              java.lang.String refId,
                                              java.lang.String content)
                                       throws YFormServiceException

Create or Update YFormDataModel.

Specified by:

createOrUpdateYFormData in interface YFormService

Parameters:

applicationId -

formId -

formDataId -

type -

refId -

content -

Returns:

YFormDataModel

Throws:

YFormServiceException - if form data cannot be created or updated

updateYFormData

public YFormDataModel updateYFormData(java.lang.String formDataId,
                                      YFormDataTypeEnum type,
                                      java.lang.String content)
                               throws YFormServiceException

Update YFormData by the given form data id.

Specified by:

updateYFormData in interface YFormService

Parameters:

formDataId -

type -

content -

Returns:

YFormDataModel

Throws:

ModelNotFoundException

YFormServiceException

createYFormData

public YFormDataModel createYFormData(java.lang.String applicationId,
                                      java.lang.String formId,
                                      java.lang.String formDataId,
                                      YFormDataTypeEnum type,
                                      java.lang.String refId,
                                      java.lang.String content)
                               throws YFormServiceException

Create YFormData if no previous exists.
It also assigns it to the corresponding YFormDefinition.

Specified by:

createYFormData in interface YFormService

Parameters:

applicationId -

formId -

formDataId -

type -

refId -

content -

Returns:

YFormDataModel

Throws:

YFormServiceException - if form data cannot be created

createYFormData

public YFormDataModel createYFormData(java.lang.String applicationId,
                                      java.lang.String formId,
                                      java.lang.String formDataId,
                                      YFormDataTypeEnum type,
                                      java.lang.String refId,
                                      java.lang.String content,
                                      java.lang.String ownerApplicationId,
                                      java.lang.String ownerFormId)
                               throws YFormServiceException

Create YFormData if no previous exists.
It also assigns it to the corresponding YFormDefinition.

Specified by:

createYFormData in interface YFormService

Parameters:

applicationId -

formId -

formDataId -

type -

refId -

content -

ownerApplicationId -

ownerFormId -

Returns:

YFormDataModel

Throws:

YFormServiceException - if form data cannot be created

createYFormData

public YFormDataModel createYFormData(java.lang.String applicationId,
                                      java.lang.String formId,
                                      java.lang.String formDataId,
                                      YFormDataTypeEnum type,
                                      java.lang.String refId,
                                      java.lang.String content,
                                      java.lang.String ownerApplicationId,
                                      java.lang.String ownerFormId,
                                      boolean system)
                               throws YFormServiceException

Create YFormData if no previous exists.
It also assigns it to the corresponding YFormDefinition.

Specified by:

createYFormData in interface YFormService

Parameters:

applicationId -

formId -

formDataId -

type -

refId -

content -

ownerApplicationId -

ownerFormId -

system -

Returns:

YFormDataModel

Throws:

YFormServiceException - if form data cannot be created

getYFormDataByRefId

public java.util.List<YFormDataModel> getYFormDataByRefId(java.lang.String refId)

For the given refId a list of YFormDataModel is returned.

Specified by:

getYFormDataByRefId in interface YFormService

Parameters:

refId -

Returns:

List

setFormDefinitionStatus

@Transactional(propagation=REQUIRED)
public void setFormDefinitionStatus(java.lang.String applicationId,
                                    java.lang.String formId,
                                    YFormDefinitionStatusEnum status)

Description copied from interface: YFormService

Set the status for all the form definitions with specific application id and form id.

Specified by:

setFormDefinitionStatus in interface YFormService

Parameters:

applicationId - the application id of the form definition

formId - the form id of the form definition

status - the new status of the form definition

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getYFormDao

protected YFormDao getYFormDao()

setYFormDao

public void setYFormDao(YFormDao yformDao)

getGetVersionNumberStrategy

protected GetVersionNumberStrategy getGetVersionNumberStrategy()

setGetVersionNumberStrategy

public void setGetVersionNumberStrategy(GetVersionNumberStrategy getVersionNumberStrategy)