com.haulmont.cuba.gui.relatedentities

Interface RelatedEntitiesAPI

All Known Implementing Classes:

RelatedEntitiesBean

public interface RelatedEntitiesAPI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RelatedEntitiesAPI.RelatedScreenDescriptor

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities, MetaClass metaClass, MetaProperty metaProperty) Shows found related entities in default browse screen.
void	openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities, MetaClass metaClass, MetaProperty metaProperty, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Shows found related entities in chosen screen.
<T extends Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property) Shows found related entities in default browse screen.
<T extends Entity> void	openRelatedScreen(java.util.Collection<T> selectedEntities, java.lang.Class<T> clazz, java.lang.String property, RelatedEntitiesAPI.RelatedScreenDescriptor descriptor) Shows found related entities in chosen screen.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

openRelatedScreen

void openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities,
                       MetaClass metaClass,
                       MetaProperty metaProperty)

Shows found related entities in default browse screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

openRelatedScreen

void openRelatedScreen(java.util.Collection<? extends Entity> selectedEntities,
                       MetaClass metaClass,
                       MetaProperty metaProperty,
                       RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Shows found related entities in chosen screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

metaClass - metaClass of single entity from selectedEntities

metaProperty - chosen field to find related entities. Can be obtained from metaClass

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption

openRelatedScreen

<T extends Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                          java.lang.Class<T> clazz,
                                          java.lang.String property)

Shows found related entities in default browse screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

openRelatedScreen

<T extends Entity> void openRelatedScreen(java.util.Collection<T> selectedEntities,
                                          java.lang.Class<T> clazz,
                                          java.lang.String property,
                                          RelatedEntitiesAPI.RelatedScreenDescriptor descriptor)

Shows found related entities in chosen screen.

Parameters:

selectedEntities - set of entities which represents one side of relation

clazz - class of single entity from selectedEntities

property - chosen field to find related entities

descriptor - descriptor contains screen id, WindowManager.OpenType and generated filter caption