de.hybris.platform.personalizationfacades.trigger

Interface TriggerFacade

All Known Implementing Classes:

DefaultTriggerFacade

public interface TriggerFacade

Facade for interacting with TriggerData

Method Summary

Modifier and Type	Method and Description
TriggerData	createTrigger(java.lang.String customizationCode, java.lang.String variationCode, TriggerData data, java.lang.String catalogId, java.lang.String catalogVersionId) Creates TriggerData in given variation from provided data
void	deleteTrigger(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String triggerCode, java.lang.String catalogId, java.lang.String catalogVersionId) Deletes trigger with given code
TriggerData	getTrigger(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String triggerCode, java.lang.String catalogId, java.lang.String catalogVersionId) Retrieves TriggerData with given code from catalog/catalogVersion/customization/variation
java.util.List<TriggerData>	getTriggers(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String catalogId, java.lang.String catalogVersionId) Retrieves all TriggerData related to given variation
TriggerData	updateTrigger(java.lang.String customizationCode, java.lang.String variationCode, java.lang.String triggerCode, TriggerData data, java.lang.String catalogId, java.lang.String catalogVersionId) Updates trigger data with given code with provided data

Method Detail

getTrigger

TriggerData getTrigger(java.lang.String customizationCode,
                       java.lang.String variationCode,
                       java.lang.String triggerCode,
                       java.lang.String catalogId,
                       java.lang.String catalogVersionId)

Retrieves TriggerData with given code from catalog/catalogVersion/customization/variation

Parameters:

customizationCode - parent customization identifier

variationCode - parent variation identifier

triggerCode - trigger identifier

catalogId - catalog identifier

catalogVersionId - catalog version identifier

Returns:

TriggerData for give code

Throws:

UnknownIdentifierException - if any of the provided identifiers is invalid

getTriggers

java.util.List<TriggerData> getTriggers(java.lang.String customizationCode,
                                        java.lang.String variationCode,
                                        java.lang.String catalogId,
                                        java.lang.String catalogVersionId)

Retrieves all TriggerData related to given variation

Parameters:

customizationCode - parent customization identifier

variationCode - parent variation identifier

catalogId - catalog identifier

catalogVersionId - catalog version identifier

Returns:

List with all TriggerData related to given variation in catalog version (may be empty)

Throws:

UnknownIdentifierException - if any of the provided identifiers is invalid

createTrigger

TriggerData createTrigger(java.lang.String customizationCode,
                          java.lang.String variationCode,
                          TriggerData data,
                          java.lang.String catalogId,
                          java.lang.String catalogVersionId)

Creates TriggerData in given variation from provided data

Parameters:

customizationCode - parent customization identifier

variationCode - parent variation identifier

data - from which trigger is created

catalogId - catalog identifier

catalogVersionId - catalog version identifier

Returns:

Created trigger data

Throws:

UnknownIdentifierException - if any of the provided identifiers is invalid

AlreadyExistsException - if trigger with given code already exist in given variation

java.lang.IllegalArgumentException - if provided data is null or contains invalid data

updateTrigger

TriggerData updateTrigger(java.lang.String customizationCode,
                          java.lang.String variationCode,
                          java.lang.String triggerCode,
                          TriggerData data,
                          java.lang.String catalogId,
                          java.lang.String catalogVersionId)

Updates trigger data with given code with provided data

Parameters:

customizationCode - parent customization identifier

variationCode - parent variation identifier

triggerCode - trigger identifier

data - from which trigger is created

catalogId - catalog identifier

catalogVersionId - catalog version identifier

Returns:

updated trigger data

Throws:

UnknownIdentifierException - if any of the provided identifiers is invalid

java.lang.IllegalArgumentException - if provided data is null or contains invalid data

deleteTrigger

void deleteTrigger(java.lang.String customizationCode,
                   java.lang.String variationCode,
                   java.lang.String triggerCode,
                   java.lang.String catalogId,
                   java.lang.String catalogVersionId)

Deletes trigger with given code

Parameters:

customizationCode - parent customization identifier

variationCode - parent variation identifier

triggerCode - trigger identifier

catalogId - catalog identifier

catalogVersionId - catalog version identifier

Throws:

UnknownIdentifierException - if any of the provided identifiers is invalid