de.hybris.platform.cockpit.services.config

Interface BaseConfiguration

All Superinterfaces:

UIComponentConfiguration

All Known Implementing Classes:

DefaultBaseConfiguration

public interface BaseConfiguration
extends UIComponentConfiguration

Provides basic configuration for a certain type

Method Summary

Modifier and Type	Method and Description
java.util.List<DefaultPropertySettings>	getAllDefaultPropertySettings() Provides all default settings configured for the type represented by this BaseConfiguration instance.
java.util.List<DefaultPropertySettings>	getBaseProperties() Provides default settings for base properties of the type represented by this BaseConfiguration instance.
DefaultPropertySettings	getDefaultPropertySettings(PropertyDescriptor propertyDescriptor) Returns default property settings for a property of the type represented by this BaseConfiguration instance.
InitialPropertyConfiguration	getInitialPropertyConfiguration(ObjectTemplate objectTemplate, TypeService typeService)
ObjectLabelProvider	getObjectLabelProvider()
SearchType	getSearchType()

Method Detail

getSearchType

SearchType getSearchType()

getObjectLabelProvider

ObjectLabelProvider getObjectLabelProvider()

getInitialPropertyConfiguration

InitialPropertyConfiguration getInitialPropertyConfiguration(ObjectTemplate objectTemplate,
                                                             TypeService typeService)

getBaseProperties

java.util.List<DefaultPropertySettings> getBaseProperties()

Provides default settings for base properties of the type represented by this BaseConfiguration instance. The order of elements in the returned list corresponds to the order of configuration entries.

Returns:

a list of default settings configured with baseProperty=true, or an empty list if no such default settings are configured for the type.

getDefaultPropertySettings

DefaultPropertySettings getDefaultPropertySettings(PropertyDescriptor propertyDescriptor)

Returns default property settings for a property of the type represented by this BaseConfiguration instance.

Parameters:

propertyDescriptor - property descriptor of a property for which the default property settings is returned.

Returns:

default property settings for the property or null if no configuration entry exists for the property.

getAllDefaultPropertySettings

java.util.List<DefaultPropertySettings> getAllDefaultPropertySettings()

Provides all default settings configured for the type represented by this BaseConfiguration instance. The order of elements in the returned list corresponds to the order of configuration entries.

Returns:

a list of all configured default settings, or an empty list if no default settings are configured for the type.