Package io.jmix.flowui.view

Interface DetailView<E>

Type Parameters:

E - type of entity

All Superinterfaces:

ChangeTracker

All Known Implementing Classes:

AdditionalBusinessDayDetailView, AssignmentDetailsPropertiesFragment, BusinessCalendarDetailView, CandidateGroupsEditView, CandidateUsersEditView, CategoryAttributesDetailView, CategoryDetailView, ContentStorageDetailView, DmnDecisionTableDetailView, EmailAttachmentEdit, EntityAttributeEdit, EntityAttributeResourcePolicyModelDetailView, EntityInspectorDetailView, EntityResourcePolicyModelDetailView, ErrorDefinitionEdit, ErrorRefPropertiesFragment, EventListenerEdit, ExecutionListenerEdit, ExtensionPropertyEdit, FieldEdit, FilterConditionDetailView, FormFieldEdit, FormOutcomeEdit, FormParamEdit, FullTextFilterConditionDetailView, GraphQLResourcePolicyModelDetailView, GroupFilterConditionDetailView, HitPolicySelectView, HolidayDetailView, InAppNotificationDetailView, InOutBindingModelEdit, InputDefinitionDetailView, InputEntryDetailView, JobDataDetailView, JobModelDetailView, JpqlFilterConditionDetailView, JpqlParameterEdit, LogicalFilterConditionDetailView, MBeanAttributeDetailView, MBeanInfoDetailView, MenuResourcePolicyModelDetailView, MessageDefinitionEdit, MultiInstanceLoopCharacteristicsPropertiesFragment, OutputDefinitionDetailView, ProcessDefinitionDetailView, ProcessInstanceDetailView, ProcessVariableEdit, PropertyFilterConditionDetailView, QueryParameterDetailView, ReportDetailView, ReportGroupDetailView, ReportParameterDetailView, ReportRegionWizardDetailView, ReportTemplateDetailView, ReportValueFormatDetailView, ResourcePolicyModelDetailView, ResourceRoleModelDetailView, RowLevelPolicyModelDetailView, RowLevelRoleModelDetailView, ScheduledBusinessDayDetailView, ScriptEditor, SignalDefinitionEdit, SpecificResourcePolicyModelDetailView, StandardDetailView, TaskListenerEdit, TenantDetailView, TriggerModelDetailView, UserGroupDetailView, UserSubstitutionDetailView, VariableInstanceDataDetail, ViewResourcePolicyModelDetailView, WebdavDocumentCollectionDetailView, WebdavShowDocumentVersionsDetailView

public interface DetailView<E>
extends ChangeTracker

Interface of views that display an entity instance and can save changes made by the user.

Method Summary

Modifier and Type	Method	Description
OperationResult	closeWithDiscard()	Discards changes and closes the view.
OperationResult	closeWithSave()	Saves changes and closes the view.
E	getEditedEntity()
PessimisticLockStatus	getPessimisticLockStatus()
OperationResult	save()	Saves changes.
void	setEntityToEdit(E entity)	Sets entity instance to the view.

Methods inherited from interface io.jmix.flowui.view.ChangeTracker

hasUnsavedChanges

Method Details

save

OperationResult save()

Saves changes.

closeWithSave

OperationResult closeWithSave()

Saves changes and closes the view.

closeWithDiscard

OperationResult closeWithDiscard()

Discards changes and closes the view.

getEditedEntity

E getEditedEntity()

Returns:

currently edited entity instance

Throws:

IllegalStateException - if the edited entity isn't initialized yet, for example in View.InitEvent

setEntityToEdit

void setEntityToEdit(E entity)

Sets entity instance to the view.

Parameters:

entity - entity to edit

getPessimisticLockStatus

PessimisticLockStatus getPessimisticLockStatus()

Returns:

lock status of the currently edited entity instance. Possible variants:

• PessimisticLockStatus.NOT_SUPPORTED - if the entity does not support pessimistic lock.
• PessimisticLockStatus.LOCKED - if the entity instance is successfully locked.
• PessimisticLockStatus.FAILED - if the entity instance has been locked when the view is opened.

See Also:

• PessimisticLock