Class DefaultYFormFacade
java.lang.Object
de.hybris.platform.xyformsfacades.form.impl.DefaultYFormFacade
- All Implemented Interfaces:
YFormFacade
Default Form Facade to handle yForm definitions and yForm data.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateEmptyYFormData(String applicationId, String formId) Create empty YFormData for YFormDefinition.createOrUpdateYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String content) Create or Update YFormDataModel.createOrUpdateYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String refId, String content) Create or Update YFormDataModel.createYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String refId, String content) Create YFormData if no previous one exists.createYFormDefinition(String applicationId, String formId, String content, String documentId) Create a new YFormDefinition by the given parameters.getFormDataContent(String applicationId, String formId, String formDataId) For a given application id, form id and form data id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweengetFormDataContentTemplate(String applicationId, String formId) For a given application id and form id a form data content template (an empty form data via createEmptyYFormData) is returned.getInlineFormHtml(String applicationId, String formId) For a given application id and form id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweengetInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId) For a given application id, form id, form data id and action an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweengetInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId, YFormPreprocessorStrategy strategy) For a given application id, form id, form data id, action and strategy an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweengetInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId, YFormPreprocessorStrategy strategy, Map<String, Object> params) For a given application id, form id, form data id, action and strategy (plus parameters) an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweengetInlineFormHtml(String applicationId, String formId, String formDataId) For a given application id, form id and form data id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged betweenGenerates a new form Data idgetYFormData(String formDataId) For a given id a form data is returned.getYFormData(String formDataId, YFormDataTypeEnum type) For a given id and type a form data is returned.getYFormData(String applicationId, String formId, String refId) For the given application id, form id and reference id a form data is returned.getYFormData(String applicationId, String formId, String refId, YFormDataTypeEnum type) For the given application id, form id, reference id and form type a form data is returned.protected Converter<YFormDataModel,YFormDataData> protected YFormDataModelgetYFormDataModel(String formDataId) For a given id a form data is returned, if there is first a DRAFT document it will be return, else the DATA version of itgetYFormDefinition(String documentId) For a given document id a form definition is returned.getYFormDefinition(String applicationId, String formId) For a given application id and form id a form definition is returned.getYFormDefinition(String applicationId, String formId, int version) For a given application id, form id and version number a form definition is returned.protected Converter<YFormDefinitionModel,YFormDefinitionData> protected YFormServicerecreateYFormDefinitionCounterpart(String applicationId, String formId, int version) Given an application id, form id and version number, the yForm Data counterpart is created.voidsetFormDefinitionStatus(String applicationId, String formId, YFormDefinitionStatusEnum status) Changes the state of a form definition.voidsetProxyFacade(ProxyFacade proxyFacade) voidsetYFormService(YFormService yformService) updateYFormData(String formDataId, YFormDataTypeEnum type, String content) Update YFormData by the given form data id.updateYFormDefinition(String applicationId, String formId, String content, String documentId) Update YFormDefinition if it exists in the database.boolean/** Indicates if the given Form Data is valid or not.protected voidvalidateFormDefinitionMetadata(String applicationId, String formId, String documentId) Checks if the metadata stored in the YFormData counterpart matches the given applicationId and formId
-
Field Details
-
ORBEON_APPLICATION_ID
- See Also:
-
ORBEON_FORM_ID
- See Also:
-
TEMPLATE_FORM_ID
- See Also:
-
-
Constructor Details
-
DefaultYFormFacade
public DefaultYFormFacade()
-
-
Method Details
-
getNewFormDataId
Generates a new form Data id- Specified by:
getNewFormDataIdin interfaceYFormFacade- Returns:
- generated form data id as string.
-
getYFormDefinition
public YFormDefinitionData getYFormDefinition(String applicationId, String formId) throws YFormServiceException For a given application id and form id a form definition is returned.- Specified by:
getYFormDefinitionin interfaceYFormFacade- Parameters:
applicationId-formId-- Returns:
- YFormDefinitionData
- Throws:
YFormServiceException- if form definition cannot with specified parameters be resolved
-
getYFormDefinition
public YFormDefinitionData getYFormDefinition(String applicationId, String formId, int version) throws YFormServiceException For a given application id, form id and version number a form definition is returned.- Specified by:
getYFormDefinitionin interfaceYFormFacade- Parameters:
applicationId-formId-version- form definition version- Returns:
- YFormDefinitionData
- Throws:
YFormServiceException- if form definition cannot with specified parameters be resolved
-
getYFormDefinition
For a given document id a form definition is returned.- Specified by:
getYFormDefinitionin interfaceYFormFacade- Parameters:
documentId-- Returns:
- YFormDefinitionData
- Throws:
YFormServiceException- if form definition cannot with specified parameters be resolved
-
createYFormDefinition
public YFormDefinitionData createYFormDefinition(String applicationId, String formId, String content, String documentId) throws YFormServiceException Create a new YFormDefinition by the given parameters.- Specified by:
createYFormDefinitionin interfaceYFormFacade- Parameters:
applicationId-formId-content-documentId-- Returns:
- YFormDefinitionData
- Throws:
YFormServiceException
-
validateFormDefinitionMetadata
protected void validateFormDefinitionMetadata(String applicationId, String formId, String documentId) throws YFormServiceException Checks if the metadata stored in the YFormData counterpart matches the given applicationId and formId- Parameters:
applicationId-formId-documentId-- Throws:
YFormServiceException
-
updateYFormDefinition
@Transactional(propagation=REQUIRED) public YFormDefinitionData updateYFormDefinition(String applicationId, String formId, String content, String documentId) throws YFormServiceException Update YFormDefinition if it exists in the database.- Specified by:
updateYFormDefinitionin interfaceYFormFacade- Parameters:
applicationId-formId-content-documentId-- Returns:
- YFormDefinitionData
- Throws:
YFormServiceException
-
getYFormData
For a given id a form data is returned. First the DRAFT version if there one, else the DATA version of it.- Specified by:
getYFormDatain interfaceYFormFacade- Parameters:
formDataId-- Returns:
- form data with given id
- Throws:
YFormServiceException
-
getYFormDataModel
For a given id a form data is returned, if there is first a DRAFT document it will be return, else the DATA version of it- Parameters:
formDataId-- Returns:
- YFormDataData
- Throws:
YFormServiceException
-
getYFormData
public YFormDataData getYFormData(String formDataId, YFormDataTypeEnum type) throws YFormServiceException For a given id and type a form data is returned.- Specified by:
getYFormDatain interfaceYFormFacade- Parameters:
formDataId-type- the type of the form data- Returns:
- YFormDataData
- Throws:
YFormServiceException- if form data cannot be found
-
getYFormData
public YFormDataData getYFormData(String applicationId, String formId, String refId, YFormDataTypeEnum type) throws YFormServiceException For the given application id, form id, reference id and form type a form data is returned.- Specified by:
getYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-refId-type-- Returns:
- YFormDataData
- Throws:
YFormServiceException
-
getYFormData
public YFormDataData getYFormData(String applicationId, String formId, String refId) throws YFormServiceException For the given application id, form id and reference id a form data is returned.- Specified by:
getYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-refId-- Returns:
- YFormDataData
- Throws:
YFormServiceException
-
recreateYFormDefinitionCounterpart
@Transactional(propagation=REQUIRED) public String recreateYFormDefinitionCounterpart(String applicationId, String formId, int version) throws YFormServiceException Given an application id, form id and version number, the yForm Data counterpart is created.- Specified by:
recreateYFormDefinitionCounterpartin interfaceYFormFacade- Parameters:
applicationId-formId-version-- Returns:
- the form id of created form data
- Throws:
YFormServiceException
-
updateYFormData
public YFormDataData updateYFormData(String formDataId, YFormDataTypeEnum type, String content) throws YFormServiceException Update YFormData by the given form data id.- Specified by:
updateYFormDatain interfaceYFormFacade- Parameters:
formDataId-type-content-- Returns:
- YFormDataData
- Throws:
YFormServiceException- if form data cannot be updated
-
createEmptyYFormData
public String createEmptyYFormData(String applicationId, String formId) throws YFormServiceException Create empty YFormData for YFormDefinition. It assigns it to the corresponding YFormDefinition via orbeon background API.- Specified by:
createEmptyYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-- Returns:
- new Id for YFormData
- Throws:
YFormServiceException- if form data cannot be created
-
createYFormData
public YFormDataData createYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String refId, String content) throws YFormServiceException Create YFormData if no previous one exists. It assigns it to the corresponding YFormDefinition.- Specified by:
createYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-formDataId-type-refId-content-- Returns:
- YFormDataData
- Throws:
YFormServiceException- if form data cannot be created
-
createOrUpdateYFormData
public YFormDataData createOrUpdateYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String refId, String content) throws YFormServiceException Create or Update YFormDataModel.- Specified by:
createOrUpdateYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-formDataId-type-refId-content-- Returns:
- YFormDataData
- Throws:
YFormServiceException- if form data cannot be created or updated
-
createOrUpdateYFormData
public YFormDataData createOrUpdateYFormData(String applicationId, String formId, String formDataId, YFormDataTypeEnum type, String content) throws YFormServiceException Create or Update YFormDataModel.- Specified by:
createOrUpdateYFormDatain interfaceYFormFacade- Parameters:
applicationId-formId-formDataId-type-content-- Returns:
- YFormDataData
- Throws:
YFormServiceException- if form data cannot be created or updated
-
getInlineFormHtml
public String getInlineFormHtml(String applicationId, String formId, String formDataId) throws YFormServiceException For a given application id, form id and form data id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getInlineFormHtmlin interfaceYFormFacade- Parameters:
applicationId-formId-formDataId- the form data id of the definition- Returns:
- String
- Throws:
YFormServiceException- if inline definition cannot be returned
-
getInlineFormHtml
For a given application id and form id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getInlineFormHtmlin interfaceYFormFacade- Parameters:
applicationId-formId-- Returns:
- the inline form definition as string
- Throws:
YFormServiceException
-
getInlineFormHtml
public String getInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId) throws YFormServiceException For a given application id, form id, form data id and action an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getInlineFormHtmlin interfaceYFormFacade- Parameters:
applicationId-formId-action-formDataId-- Returns:
- the inline form definition as string
- Throws:
YFormServiceException
-
getInlineFormHtml
public String getInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId, YFormPreprocessorStrategy strategy) throws YFormServiceException For a given application id, form id, form data id, action and strategy an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getInlineFormHtmlin interfaceYFormFacade- Parameters:
applicationId-formId-action-formDataId-strategy-- Returns:
- the inline form definition as string
- Throws:
YFormServiceException
-
getInlineFormHtml
public String getInlineFormHtml(String applicationId, String formId, YFormDataActionEnum action, String formDataId, YFormPreprocessorStrategy strategy, Map<String, Object> params) throws YFormServiceExceptionFor a given application id, form id, form data id, action and strategy (plus parameters) an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getInlineFormHtmlin interfaceYFormFacade- Parameters:
applicationId-formId-action-formDataId-strategy-params-- Returns:
- the inline form definition as string
- Throws:
YFormServiceException
-
getFormDataContent
public String getFormDataContent(String applicationId, String formId, String formDataId) throws YFormServiceException For a given application id, form id and form data id an inline form definition is returned.
The inline form definition can be injected in to a page instead of getting entire xform tagged between- Specified by:
getFormDataContentin interfaceYFormFacade- Parameters:
applicationId-formId-formDataId-- Returns:
- the content of form data
- Throws:
YFormServiceException
-
getFormDataContentTemplate
public String getFormDataContentTemplate(String applicationId, String formId) throws YFormServiceException Description copied from interface:YFormFacadeFor a given application id and form id a form data content template (an empty form data via createEmptyYFormData) is returned.- Specified by:
getFormDataContentTemplatein interfaceYFormFacade- Parameters:
applicationId- the application id of the form definitionformId- the form id of the form definition- Returns:
- form data content template for definition with specified parameters
- Throws:
YFormServiceException- if there is no YFormDefinition with given applicationId and formId or YFormDefinition has wrong content
-
validate
public boolean validate(String applicationId, String formId, String formDataId) throws YFormServiceException /** Indicates if the given Form Data is valid or not.- Specified by:
validatein interfaceYFormFacade- Parameters:
applicationId-formId-formDataId-- Returns:
- true if form data is valid, false otherwise
- Throws:
YFormServiceException
-
setFormDefinitionStatus
public void setFormDefinitionStatus(String applicationId, String formId, YFormDefinitionStatusEnum status) throws YFormServiceException Changes the state of a form definition. This will include all related versions.- Specified by:
setFormDefinitionStatusin interfaceYFormFacade- Parameters:
status-applicationId- the application id of the form definitionformId- the form id of the form definition- Throws:
YFormServiceException- if form definition cannot be found or updated
-
getYFormService
-
setYFormService
-
setProxyFacade
-
getYFormDefinitionConverter
-
getYFormDataConverter
-