com.haulmont.cuba.core.global

Interface ViewRepository

All Known Implementing Classes:

AbstractViewRepository, TestViewRepositoryClient, ViewRepositoryClientImpl, ViewRepositoryImpl

public interface ViewRepository

Represents a repository of View objects, accessible by names.
Repository contains all views defined in XML and deployed at runtime.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
View	findView(MetaClass metaClass, java.lang.String name) Searches for a View for an entity.
View	getView(java.lang.Class<? extends Entity> entityClass, java.lang.String name) Get View for an entity.
View	getView(MetaClass metaClass, java.lang.String name) Get View for an entity.
java.util.Collection<java.lang.String>	getViewNames(java.lang.Class<? extends Entity> entityClass) Returns names of views defined for the entityClass
java.util.Collection<java.lang.String>	getViewNames(MetaClass metaClass) Returns names of views defined for the metaClass

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getView

View getView(java.lang.Class<? extends Entity> entityClass,
             java.lang.String name)

Get View for an entity.

Parameters:

entityClass - entity class

name - view name

Returns:

view instance. Throws ViewNotFoundException if not found.

getView

View getView(MetaClass metaClass,
             java.lang.String name)

Get View for an entity.

Parameters:

metaClass - entity class

name - view name

Returns:

view instance. Throws ViewNotFoundException if not found.

findView

@Nullable
View findView(MetaClass metaClass,
                        java.lang.String name)

Searches for a View for an entity.

Parameters:

metaClass - entity class

name - view name

Returns:

view instance or null if no view found

getViewNames

java.util.Collection<java.lang.String> getViewNames(MetaClass metaClass)

Returns names of views defined for the metaClass

Parameters:

metaClass - entity class

Returns:

names of views

getViewNames

java.util.Collection<java.lang.String> getViewNames(java.lang.Class<? extends Entity> entityClass)

Returns names of views defined for the entityClass

Parameters:

entityClass - entity class

Returns:

names of views