de.hybris.platform.commerceservices.consent.impl

Class DefaultCommerceConsentService

java.lang.Object

de.hybris.platform.commerceservices.consent.impl.DefaultCommerceConsentService

All Implemented Interfaces:

CommerceConsentService

public class DefaultCommerceConsentService
extends java.lang.Object
implements CommerceConsentService

Default implementation of CommerceConsentService

Constructor Summary

Constructors

Constructor and Description
DefaultCommerceConsentService()

Method Summary

Modifier and Type	Method and Description
protected ConsentModel	createConsentModel(CustomerModel customer, ConsentTemplateModel consentTemplate)
ConsentModel	getActiveConsent(CustomerModel customer, ConsentTemplateModel consentTemplate) Finds the latest consent for the specified customer and consent template.
ConsentModel	getConsent(java.lang.String consentCode) Finds the consent for the specified consentCode
protected ConsentDao	getConsentDao()
ConsentTemplateModel	getConsentTemplate(java.lang.String consentTemplateId, java.lang.Integer consentTemplateVersion, BaseSiteModel baseSite) Finds the consent template for the supplied consentTemplateId, consentTemplateVersion and baseSite.
protected ConsentTemplateDao	getConsentTemplateDao()
java.util.List<ConsentTemplateModel>	getConsentTemplates(BaseSiteModel baseSite) Finds all the latest versions of consent templates for the given baseSite.
ConsentTemplateModel	getLatestConsentTemplate(java.lang.String consentTemplateId, BaseSiteModel baseSite) Finds the latest version of a ConsentTemplate for the given consentTemplateId and baseSite.
protected ModelService	getModelService()
protected TimeService	getTimeService()
void	giveConsent(CustomerModel customer, ConsentTemplateModel consentTemplate) Gives consent for the specified customer and consent template.
boolean	hasEffectivelyActiveConsent(CustomerModel customer, ConsentTemplateModel consentTemplate) Checks if a customer has a consent that has not been withdrawn for the specified consent template.
protected boolean	isConsentWithdrawn(ConsentModel consent)
void	setConsentDao(ConsentDao consentDao)
void	setConsentTemplateDao(ConsentTemplateDao consentTemplateDao)
void	setModelService(ModelService modelService)
void	setTimeService(TimeService timeService)
void	withdrawConsent(ConsentModel consent) Withdraws consent for the specified ConsentModel by updating the consentWithdrawnDate. 1.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultCommerceConsentService

public DefaultCommerceConsentService()

Method Detail

getConsentTemplates

public java.util.List<ConsentTemplateModel> getConsentTemplates(BaseSiteModel baseSite)

Description copied from interface: CommerceConsentService

Finds all the latest versions of consent templates for the given baseSite.

Specified by:

getConsentTemplates in interface CommerceConsentService

Parameters:

baseSite - the baseSite to retrieve the consent template for

Returns:

available consent templates

getConsentTemplate

public ConsentTemplateModel getConsentTemplate(java.lang.String consentTemplateId,
                                               java.lang.Integer consentTemplateVersion,
                                               BaseSiteModel baseSite)

Description copied from interface: CommerceConsentService

Finds the consent template for the supplied consentTemplateId, consentTemplateVersion and baseSite.

Specified by:

getConsentTemplate in interface CommerceConsentService

Parameters:

consentTemplateId - the id of the consent template

consentTemplateVersion - the version of the consent template

baseSite - the baseSite to retrieve the consent template for

Returns:

the consent template

getLatestConsentTemplate

public ConsentTemplateModel getLatestConsentTemplate(java.lang.String consentTemplateId,
                                                     BaseSiteModel baseSite)

Description copied from interface: CommerceConsentService

Finds the latest version of a ConsentTemplate for the given consentTemplateId and baseSite.

Specified by:

getLatestConsentTemplate in interface CommerceConsentService

Parameters:

consentTemplateId - the id of the consent template

baseSite - the baseSite to retrieve the consent template for.

Returns:

the consent template

getConsent

public ConsentModel getConsent(java.lang.String consentCode)

Description copied from interface: CommerceConsentService

Finds the consent for the specified consentCode

Specified by:

getConsent in interface CommerceConsentService

Parameters:

consentCode - the consent code to get the consent for

Returns:

the consent

getActiveConsent

public ConsentModel getActiveConsent(CustomerModel customer,
                                     ConsentTemplateModel consentTemplate)

Description copied from interface: CommerceConsentService

Finds the latest consent for the specified customer and consent template.

Specified by:

getActiveConsent in interface CommerceConsentService

Parameters:

customer - the customer to get the consent for

consentTemplate - the consent template to get the consent for

Returns:

the consent if found, otherwise null

hasEffectivelyActiveConsent

public boolean hasEffectivelyActiveConsent(CustomerModel customer,
                                           ConsentTemplateModel consentTemplate)

Description copied from interface: CommerceConsentService

Checks if a customer has a consent that has not been withdrawn for the specified consent template.

Specified by:

hasEffectivelyActiveConsent in interface CommerceConsentService

Parameters:

customer - the customer to check the consent for

consentTemplate - the consent template to check the consent for

Returns:

true, if the customer has a consent that has not been withdrawn

giveConsent

public void giveConsent(CustomerModel customer,
                        ConsentTemplateModel consentTemplate)

Description copied from interface: CommerceConsentService

Gives consent for the specified customer and consent template. Creates a new Consent and sets the consentGivenDate.

1. Doesn't create a new consent if the consent is already given and active.

Specified by:

giveConsent in interface CommerceConsentService

Parameters:

customer - the customer to give the consent for

consentTemplate - the consent template to give the consent for

withdrawConsent

public void withdrawConsent(ConsentModel consent)

Description copied from interface: CommerceConsentService

Withdraws consent for the specified ConsentModel by updating the consentWithdrawnDate.

1. Doesn't withdraw the consent if its already withdrawn, i.e, If Consent.consentWithdrawnDate is already set calling this method will not overwrite the existing value.

Specified by:

withdrawConsent in interface CommerceConsentService

Parameters:

consent - the consent to withdraw the consent for

isConsentWithdrawn

protected boolean isConsentWithdrawn(ConsentModel consent)

createConsentModel

protected ConsentModel createConsentModel(CustomerModel customer,
                                          ConsentTemplateModel consentTemplate)

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getTimeService

protected TimeService getTimeService()

setTimeService

public void setTimeService(TimeService timeService)

getConsentDao

protected ConsentDao getConsentDao()

setConsentDao

public void setConsentDao(ConsentDao consentDao)

getConsentTemplateDao

protected ConsentTemplateDao getConsentTemplateDao()

setConsentTemplateDao

public void setConsentTemplateDao(ConsentTemplateDao consentTemplateDao)