de.espirit.firstspirit.ui.operations

Interface OpenElementMetaFormOperation

public interface OpenElementMetaFormOperation

Operation providing means to open an element's meta data form.

Since:

5.0.102

Field Summary

Fields

Modifier and Type	Field and Description
static OperationType<OpenElementMetaFormOperation>	TYPE Operation providing means to open an element's meta data form.

Method Summary

Methods

Modifier and Type	Method and Description
RemoteFormData	perform(IDProvider element) Perform the operation on the given element.
void	setField(String name) Set a form field's name to focus on.
void	setFormData(FormData formData) Set a form data container providing overriding values for form fields.
void	setOpenEditable(boolean editable) Requests the displayed form to be opened for editing.

Field Detail

TYPE

static final OperationType<OpenElementMetaFormOperation> TYPE

Operation providing means to open an element's meta data form.

Since:

5.0.102

Method Detail

setField

void setField(String name)

Set a form field's name to focus on. If the meta form does not have a field with the name given or the respective field cannot be focused, this setting will be ignored.

Parameters:

name - The name of the form field.

Since:

5.0.102

setFormData

void setFormData(FormData formData)

Set a form data container providing overriding values for form fields. If a field of the meta form is not provided or is not set, the original meta value of that field will be used. If meta information are inherited, providing form data will have no effect.

Parameters:

formData - A form data container.

Since:

5.0.102

setOpenEditable

void setOpenEditable(boolean editable)

Requests the displayed form to be opened for editing. If this fails for any reason, this setting will silently be ignored and the form will be displayed read only.

Parameters:

editable - true, to request opening the form editable.

Since:

5.0.102

perform

@NotNull
RemoteFormData perform(IDProvider element)
                       throws OperationSetupException

Perform the operation on the given element.

Parameters:

element - The element to open the meta form for.

Returns:

A form data providing access to the fields of the opened form. If a modifying access is not possible, a read only form data will be provided.

Throws:

OperationSetupException - If the operation cannot be performed with the given setup.

Since:

5.0.102