de.xima.fc.api.entity

Class FormVersionAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<FormVersion>

de.xima.fc.api.entity.FormVersionAPI

public class FormVersionAPI
extends AEntityAPI<FormVersion>

API-Klassse zur Manipulation von FormVersion-Entitäten

Author:

Michael Kohlsche

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor and Description
FormVersionAPI()

Method Summary

Modifier and Type	Method and Description
FormVersion	create(UserContext uc, FormVersion formVersion, boolean isFirstFormVersion) Methode zum Erstellen einer FormVersion-Entität.
FormVersion	getBy(UserContext uc, Projekt projekt, int formVersionNumber) Methode zum Ermitteln einer FormVersion basierend auf einem Projekt und einer Versions-Nummer.
List<FormVersion>	getByProjekt(UserContext uc, Projekt projekt) Methode zum Laden von FormVersionen eines Projekts.
com.alibaba.fastjson.JSONObject	getFormAsJSON(UserContext uc, FormVersion fv) Diese Methode liefert das JSON zur Erzeugung eines XForms ohne jegliche Styles.
String	getFormAsString(UserContext uc, FormVersion fv)
List<FormElement>	getFormElemente(UserContext uc, FormVersion formVersion) Methode zum übermitteln aller FormElemente einer FormVersion.
int	getFormVersionCount(UserContext uc, Projekt projekt) Methode zum Bestimmen der Anzahl von FormVersions eines Projekts
com.alibaba.fastjson.JSONObject	mergeFormElemente(UserContext uc, FormVersion fv) Deprecated. will be removed because of 3 year old migration!

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, getAll, getAllBy, getBy, getById, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

FormVersionAPI

public FormVersionAPI()

Method Detail

create

public FormVersion create(UserContext uc,
                          FormVersion formVersion,
                          boolean isFirstFormVersion)

Methode zum Erstellen einer FormVersion-Entität.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

formVersion - FormVersion welche erstellt werden soll

isFirstFormVersion - Boolean ob dies die erste FormVersion ist oder nur eine Ableitung eiener bestehenden

Returns:

FormVersion welche erstellt wurde

Since:

2.4.3

getBy

public FormVersion getBy(UserContext uc,
                         Projekt projekt,
                         int formVersionNumber)

Methode zum Ermitteln einer FormVersion basierend auf einem Projekt und einer Versions-Nummer.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - Projekt in welchem die FormVersion gesucht wird

formVersionNumber - Integer die Versionsnummer

Returns:

FormVersion welche gesucht wurde

Since:

2.4.3

getByProjekt

public List<FormVersion> getByProjekt(UserContext uc,
                                      Projekt projekt)

Methode zum Laden von FormVersionen eines Projekts. Diese muss im Frontendserver genutzt werden um die Lazy-Initialized Liste der FormVersionen abzuholen.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - für welches die FormVersionen abgeholt werden sollen

Returns:

Liste mit FormVersionen

Since:

2.4.3

getFormVersionCount

public int getFormVersionCount(UserContext uc,
                               Projekt projekt)

Methode zum Bestimmen der Anzahl von FormVersions eines Projekts

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

projekt - Projekt dessen Anzahl an FormVersions ermittelt werden soll

Returns:

Integer die Anzahl an FormVersions

Since:

2.4.3

getFormElemente

public List<FormElement> getFormElemente(UserContext uc,
                                         FormVersion formVersion)

Methode zum übermitteln aller FormElemente einer FormVersion. Diese muss im Frontendserver genutzt werden um die Lazy-Initialized Liste der FormElement abzuholen.

Parameters:

uc - UserContext der Benutzerkontext in welchem die Aktion durchgeführt werden soll

formVersion - für welche die Liste der FormElement geladen werden soll

Returns:

List vom Typ FormElement

Since:

2.4.3

getFormAsJSON

public com.alibaba.fastjson.JSONObject getFormAsJSON(UserContext uc,
                                                     FormVersion fv)
                                              throws IOException,
                                                     com.alibaba.fastjson.JSONException

Diese Methode liefert das JSON zur Erzeugung eines XForms ohne jegliche Styles. Diese Funktinalität wird für die interne Verarbeitung genutzt und sogt dafür, dass das FD2-Projekt eigenständig bleibt.

Parameters:

fv - die FormVersion die angibt welches JSON geladen werden soll

Returns:

das Formular als JSON

Throws:

IOException - Fehler beim Lesen der Formulardatei

com.alibaba.fastjson.JSONException - Fehler beim Umwandel des Formulardateiinhalts in ein JSON

getFormAsString

public String getFormAsString(UserContext uc,
                              FormVersion fv)
                       throws IOException,
                              com.alibaba.fastjson.JSONException

Throws:

IOException

com.alibaba.fastjson.JSONException

mergeFormElemente

@Deprecated
public com.alibaba.fastjson.JSONObject mergeFormElemente(UserContext uc,
                                                                     FormVersion fv)
                                                              throws com.alibaba.fastjson.JSONException,
                                                                     IOException

Deprecated. will be removed because of 3 year old migration!

Throws:

com.alibaba.fastjson.JSONException

IOException