Package de.xima.fc.api.entity

Class FormElementAPI

java.lang.Object

de.xima.fc.api.ASubAPI

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

de.xima.fc.api.entity.FormElementAPI

public class FormElementAPI
extends AEntityAPI<FormElement>

API class for manipulation of FormElement entities.

Author:

XIMA MEDIA GmbH

Field Summary

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

entityClass

Constructor Summary

Constructors

Constructor	Description
FormElementAPI()

Method Summary

Modifier and Type	Method	Description
List<FormElement>	getAllByFormVersion(UserContext uc, FormVersion fv)	Method for determining all FormElement objects of a FormVersion.
FormElement	getByUUID(UserContext uc, FormVersion formVersion, String uuid)	Returns the form element with the given UUID string
FormElement	getByUUID(UserContext uc, FormVersion formVersion, UUID uuid)	Returns the form element with the given UUID
void	removeAllFromFormVersion(UserContext uc, FormVersion fv)	Method for deleting all FormElements of a FormVersion.

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

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, 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

FormElementAPI

public FormElementAPI()

Method Detail

getAllByFormVersion

public List<FormElement> getAllByFormVersion(UserContext uc,
                                             FormVersion fv)

Method for determining all FormElement objects of a FormVersion.

Parameters:

uc - UserContext the user context in which the action is to be performed.

fv - FormVersion whose FormElement objects are searched.

Returns:

List with the searched FormElement objects.

Since:

2.4.3

getByUUID

public FormElement getByUUID(UserContext uc,
                             FormVersion formVersion,
                             String uuid)

Returns the form element with the given UUID string

Parameters:

uc - UserContext to use

formVersion - FormVersion context in which to look for form element

uuid - String UUID string of the form element

Returns:

FormElement for the given UUID and form version

Since:

6.x.x

getByUUID

public FormElement getByUUID(UserContext uc,
                             FormVersion formVersion,
                             UUID uuid)

Returns the form element with the given UUID

Parameters:

uc - UserContext to use

formVersion - FormVersion context in which to look for form element

uuid - UUID UUID of the form element

Returns:

FormElement for the given UUID and form version

Since:

6.x.x

removeAllFromFormVersion

public void removeAllFromFormVersion(UserContext uc,
                                     FormVersion fv)

Method for deleting all FormElements of a FormVersion.

Parameters:

uc - UserContext the user context in which the action is to be performed.

fv - FormVersion whose FormElement objects are searched.

Since:

2.4.3