Package de.hybris.platform.smarteditwebservices.configuration.facade

Interface SmarteditConfigurationFacade

All Known Implementing Classes:

DefaultSmarteditConfigurationFacade

public interface SmarteditConfigurationFacade

Interface methods for SmarteditConfigurationFacade. The implementing class will provide methods for validating, populating and persisting configuration models.

Method Summary

Modifier and Type	Method	Description
ConfigurationData	create(ConfigurationData configurationData)	Create a new configuration model
void	delete(String uid)	Deletes the configuration model represented by this unique identifier
List<ConfigurationData>	findAll()	Finds all ConfigurationData stores in the data store.
ConfigurationData	findByDefaultConfigurationKey(DefaultConfigurationKey key)	Finds a configuration data bean using one of the identifiers that are provided by default
ConfigurationData	findByUid(String uid)	Finds a configuration data bean by its unique identifier
Optional<ConfigurationData>	tryAndFindByDefaultConfigurationKey(DefaultConfigurationKey key)	Will try and find a configuration data bean using one of the identifiers that are provided by default
ConfigurationData	update(String uid, ConfigurationData configurationData)	Updates the configuration model represented by the uid

Method Details

findAll

List<ConfigurationData> findAll()

Finds all ConfigurationData stores in the data store.

Returns:

a list of ConfigurationData

create

ConfigurationData create(ConfigurationData configurationData)

Create a new configuration model

Parameters:

configurationData - the data bean containing the values to be saved

Returns:

the ConfigurationData created

update

ConfigurationData update(String uid,
 ConfigurationData configurationData)

Updates the configuration model represented by the uid

Parameters:

uid - is the unique identifier of this configuration

configurationData - - the data bean to be updated

Returns:

the configuration bean updated

findByUid

ConfigurationData findByUid(String uid)

Finds a configuration data bean by its unique identifier

Parameters:

uid - the configuration's unique identifier

Returns:

the ConfigurationData represented by this uid

findByDefaultConfigurationKey

ConfigurationData findByDefaultConfigurationKey(DefaultConfigurationKey key)

Finds a configuration data bean using one of the identifiers that are provided by default

Parameters:

key - one of the DefaultConfigurationKey

Returns:

the ConfigurationData represented by this DefaultConfigurationKey

tryAndFindByDefaultConfigurationKey

Optional<ConfigurationData> tryAndFindByDefaultConfigurationKey(DefaultConfigurationKey key)

Will try and find a configuration data bean using one of the identifiers that are provided by default

Parameters:

key - one of the DefaultConfigurationKey

Returns:

the Optional<ConfigurationData> represented by this DefaultConfigurationKey

delete

void delete(String uid)

Deletes the configuration model represented by this unique identifier

Parameters:

uid - the model's unique identifier