io.jmix.core

Interface InstanceNameProvider

All Known Implementing Classes:

InstanceNameProviderImpl

public interface InstanceNameProvider

Provide instance name and instance name properties.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getInstanceName(java.lang.Object instance) Get entity instance name defined by InstanceName annotation
java.util.Collection<MetaProperty>	getInstanceNameRelatedProperties(MetaClass metaClass, boolean useOriginal) Return a collection of properties included into entity's name pattern (see InstanceName).

Method Detail

getInstanceName

java.lang.String getInstanceName(java.lang.Object instance)

Get entity instance name defined by InstanceName annotation

Parameters:

instance - instance

Returns:

instance name

getInstanceNameRelatedProperties

java.util.Collection<MetaProperty> getInstanceNameRelatedProperties(MetaClass metaClass,
                                                                    boolean useOriginal)

Return a collection of properties included into entity's name pattern (see InstanceName).

Parameters:

metaClass - entity metaclass

useOriginal - if true, and if the given metaclass doesn't define a InstanceName and if it is an extended entity, this method tries to find a name pattern in an original entity

Returns:

collection of the name pattern properties