de.hybris.platform.cockpit

Interface CockpitConfigurationService

All Known Implementing Classes:

DefaultCockpitConfigurationService

public interface CockpitConfigurationService

Service that allows to fetch existing cockpit configurations from the system. To create new configurations use ModelService.

Method Summary

Modifier and Type	Method and Description
CockpitUIComponentConfigurationModel	getComponentConfiguration(PrincipalModel principal, java.lang.String objectTemplateCode, java.lang.String code) Gets the component configuration.
java.util.List<CockpitUIComponentConfigurationModel>	getComponentConfigurationsForPrincipal(PrincipalModel principal) Gets the component configurations for principal.
java.util.List<CockpitUIComponentConfigurationModel>	getDedicatedComponentConfigurationsForPrincipal(PrincipalModel principal) Gets dedicated component configurations for principal.
java.util.List<java.lang.String>	getRoleNamesForPrincipal(PrincipalModel principal) Gets the role names for principal.
void	removeComponentConfigurations(java.util.List<CockpitUIComponentConfigurationModel> configurations) Removes the given component configurations from persistence.

Method Detail

getComponentConfigurationsForPrincipal

java.util.List<CockpitUIComponentConfigurationModel> getComponentConfigurationsForPrincipal(PrincipalModel principal)

Gets the component configurations for principal. This also includes configurations for supergroups.

Parameters:

principal - the principal

Returns:

the component configurations for principal

getDedicatedComponentConfigurationsForPrincipal

java.util.List<CockpitUIComponentConfigurationModel> getDedicatedComponentConfigurationsForPrincipal(PrincipalModel principal)

Gets dedicated component configurations for principal. Supergroups are not included.

removeComponentConfigurations

void removeComponentConfigurations(java.util.List<CockpitUIComponentConfigurationModel> configurations)

Removes the given component configurations from persistence. Also deletes the related CockpitUIConfigurationMediaModel items if they are not shared with another CockpitUIComponentConfigurationModel.

Parameters:

configurations - the configurations that should be removed.

getComponentConfiguration

CockpitUIComponentConfigurationModel getComponentConfiguration(PrincipalModel principal,
                                                               java.lang.String objectTemplateCode,
                                                               java.lang.String code)

Gets the component configuration.

Parameters:

principal - the principal

objectTemplateCode - the object template code

code - the code

Returns:

the component configuration

getRoleNamesForPrincipal

java.util.List<java.lang.String> getRoleNamesForPrincipal(PrincipalModel principal)

Gets the role names for principal.

Parameters:

principal - the principal

Returns:

the role names for principal