com.technia.helium.form.ajax

Class FormService

java.lang.Object

com.technia.helium.form.ajax.FormService

@AjaxService(value="heliumForm")
 @ConverterExtensions(value={FormInputConverterExt.class,FormContextConverterExt.class})
public class FormService
extends java.lang.Object

Ajax service dealing with Forms

Since:

2015.2.0

Constructor Summary

Constructors

Constructor and Description
FormService()

Method Summary

Modifier and Type	Method and Description
void	finalizeFCSUpload(java.lang.String objectId, java.lang.String receipt, java.lang.String fileName, boolean useCDM) Finalize an FCS file upload
com.technia.tvc.core.db.fcs.FCSUrl	getFCSUploadUrl(java.lang.String objectId, java.lang.String fileName, java.lang.String format) Get FCS file upload URL
com.technia.helium.form.ajax.FormService.ReturnValue<Form>	getForm(java.lang.String formDefinition, java.lang.String objectId) Ajax method that get the Form with data.
com.technia.helium.form.ajax.FormService.ReturnValue<Form>	getMassUpdateForm(java.lang.String formDefinition, java.lang.String bindKey, java.lang.String columnName) The Ajax method that get the mass update form with data.
com.technia.helium.form.ajax.FormService.ReturnValue<Form>	loadForm(java.lang.String formDefinition, FormContext inContextOf) Ajax method that loads the Form with data.
com.technia.helium.form.ajax.FormService.ReturnValue<UpdateResult>	performCreate(java.lang.String formDefinition, FormContext inContextOf, FormInput input) Ajax method that is used when a form is used for creating something.
com.technia.helium.form.ajax.FormService.ReturnValue<UpdateResult>	performEdit(java.lang.String formDefinition, FormContext inContextOf, FormInput input) Ajax method that is used when a form is used for Editing an already existing item.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormService

public FormService()

Method Detail

loadForm

@AjaxMethod(useContext=true,
            txType=READ)
 @JsonSerializerClass(value=DefaultJsonSerializer.class)
public com.technia.helium.form.ajax.FormService.ReturnValue<Form> loadForm(java.lang.String formDefinition,
                                                                                                                                                                                          FormContext inContextOf)

Ajax method that loads the Form with data.

Parameters:

formDefinition - The name of the form definition

inContextOf - The context in which the form is being used

Returns:

a Form

Since:

2015.2.0

getForm

@AjaxMethod(useContext=true,
            txType=READ)
 @JsonSerializerClass(value=DefaultJsonSerializer.class)
public com.technia.helium.form.ajax.FormService.ReturnValue<Form> getForm(java.lang.String formDefinition,
                                                                                                                                                                                         java.lang.String objectId)

Ajax method that get the Form with data.

Parameters:

formDefinition - The name of the form definition

objectId - (optional), the object used as source for data

Returns:

a Form

Since:

2018.1.0

getMassUpdateForm

@AjaxMethod(useContext=true,
            txType=READ)
 @JsonSerializerClass(value=DefaultJsonSerializer.class)
public com.technia.helium.form.ajax.FormService.ReturnValue<Form> getMassUpdateForm(java.lang.String formDefinition,
                                                                                                                                                                                                   java.lang.String bindKey,
                                                                                                                                                                                                   java.lang.String columnName)

The Ajax method that get the mass update form with data.

Parameters:

formDefinition - The name of the form definition

bindKey - The datatable bindkey

columnName - The column name

Returns:

a Form

Since:

2021.4.0

performEdit

@AjaxMethod(useContext=true,
            txType=UPDATE)
 @JsonSerializerClass(value=DefaultJsonSerializer.class)
public com.technia.helium.form.ajax.FormService.ReturnValue<UpdateResult> performEdit(java.lang.String formDefinition,
                                                                                                                                                                                                       FormContext inContextOf,
                                                                                                                                                                                                       FormInput input)

Ajax method that is used when a form is used for Editing an already existing item.

Parameters:

formDefinition - The name of the form definition

inContextOf - The context in which the form is being used

input -

Returns:

the result of the edit

Since:

2015.2.0

performCreate

@AjaxMethod(useContext=true,
            txType=UPDATE)
 @JsonSerializerClass(value=DefaultJsonSerializer.class)
public com.technia.helium.form.ajax.FormService.ReturnValue<UpdateResult> performCreate(java.lang.String formDefinition,
                                                                                                                                                                                                         FormContext inContextOf,
                                                                                                                                                                                                         FormInput input)

Ajax method that is used when a form is used for creating something.

Parameters:

formDefinition - The name of the form definition

inContextOf - The context in which the form is being used

input -

Returns:

the result of the creation

Throws:

com.technia.tvc.core.TVCException

Since:

2015.2.0

getFCSUploadUrl

@AjaxMethod(async=true,
            useContext=true)
public com.technia.tvc.core.db.fcs.FCSUrl getFCSUploadUrl(java.lang.String objectId,
                                                                                                               java.lang.String fileName,
                                                                                                               java.lang.String format)
                                                                                                        throws com.technia.tvc.core.TVCException

Get FCS file upload URL

Parameters:

objectId - Object to upload on

fileName - File name

format - Format to check in to

Returns:

URL to FCS upload

Throws:

com.technia.tvc.core.TVCException

Since:

2016.2.0

finalizeFCSUpload

@AjaxMethod(async=true,
            useContext=true,
            txType=UPDATE)
public void finalizeFCSUpload(java.lang.String objectId,
                                                                                                              java.lang.String receipt,
                                                                                                              java.lang.String fileName,
                                                                                                              boolean useCDM)
                                                                                                       throws com.technia.tvc.core.TVCException

Finalize an FCS file upload

Parameters:

objectId - Object to upload on

receipt - Receipt needed to finalize

Throws:

com.technia.tvc.core.TVCException

Since:

2016.2.0