de.hybris.platform.cms2.servicelayer.services.admin.impl

Class DefaultCMSAdminRestrictionService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

de.hybris.platform.cms2.servicelayer.services.admin.impl.DefaultCMSAdminRestrictionService

All Implemented Interfaces:

CMSAdminRestrictionService, Serializable

public class DefaultCMSAdminRestrictionService
extends AbstractCMSAdminService
implements CMSAdminRestrictionService

Default implementation of the restriction service.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields

Modifier and Type	Field and Description
protected CategoryService	categoryService Deprecated. Implement the CategoryService as own property
protected CMSAdminPageService	cmsAdminPageService Deprecated. Implement the CMSAdminPageService as own property
protected CMSRestrictionDao	cmsRestrictionDao Deprecated. Implement the CMSRestrictionDao as own property
protected ProductService	productService Deprecated. Implement the ProductService as own property
protected TypeService	typeService Deprecated. Implement the TypeService as own property

Fields inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

ACTIVECATALOGVERSION, ACTIVESITE

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCMSAdminRestrictionService()

Method Summary

Modifier and Type	Method and Description
CMSCatalogRestrictionModel	createCatalogRestriction(AbstractPageModel page, String id, String name, Collection<CatalogModel> catalogs) Creates a new CatalogRestriction and a new relation between the restriction and the given page.
CMSCategoryRestrictionModel	createCategoryRestriction(AbstractPageModel page, String id, String name, Collection<CategoryModel> categories) Creates a new CategoryRestriction and a new relation between the restriction and the given page
CMSProductRestrictionModel	createProductRestriction(AbstractPageModel page, String id, String name, Collection<ProductModel> products) Creates a new ProductRestriction and a new relation between the restriction and the given page
void	createRelation(AbstractPageModel page, AbstractRestrictionModel restriction) creates a new relation between the given page and the given restriction
void	createRelation(String pageId, String restrictionId) creates a new relation between the given page (pageId) and the given restriction (restrictionId)
CMSTimeRestrictionModel	createTimeRestriction(AbstractPageModel page, String id, String name, Date from, Date until) Creates a new TimeRestriction and a new relation between the restriction and the given page
CMSUserGroupRestrictionModel	createUserGroupRestriction(AbstractPageModel page, String id, String name, Collection<UserGroupModel> userGroups) Creates a new UserGroupRestriction and a new relation between the restriction and the given page
CMSUserRestrictionModel	createUserRestriction(AbstractPageModel page, String id, String name, Collection<UserModel> users) Creates a new UserRestriction and a new relation between the restriction and the given page
void	deleteRelation(AbstractRestrictionModel restriction, AbstractPageModel page) deletes the relation between the restriction and the page
void	deleteRelation(String restrictionId, String pageId) deletes the relation between the restriction and the page
Collection<RestrictionTypeModel>	getAllowedRestrictionTypesForPage(AbstractPageModel page) Returns a collection of all restrictions which can be applied on the given page
Collection<RestrictionTypeModel>	getAllowedRestrictionTypesForPage(String id) Returns a collection of all restrictions which can be applied on the given page (via its id)
Collection<AbstractRestrictionModel>	getAllRestrictions() Returns all restriction
Collection<AbstractRestrictionModel>	getAllRestrictionsByType(String restrictionType) Returns all restriction of the given restriction type
Collection<AbstractRestrictionModel>	getAllRestrictionsByTypeNotLinkedToPage(String pageId, String restrictionType) Returns all restrictions of the given restriction type which are currently not linked to the given page (via its id)
Collection<RestrictionTypeModel>	getAllRestrictionTypes() Returns a collection of all available restriction types.
List<CategoryModel>	getCategories(CMSCategoryRestrictionModel categoryRestriction, PreviewDataModel previewContext) Returns products for product restriction
protected CMSRestrictionDao	getCmsRestrictionDao()
protected ComposedTypeModel	getComposedTypeModel(String composedType)
protected Locale	getLocalLocale(PreviewDataModel previewContext)
protected UserModel	getLocalUser(PreviewDataModel previewContext)
List<ProductModel>	getProducts(CMSProductRestrictionModel productRestriction, PreviewDataModel previewContext) Returns products for product restriction
AbstractRestrictionModel	getRestriction(String id) Returns a restriction via its id
List<AbstractRestrictionModel>	getRestrictionsByName(String name) Returns a restriction via its name
Collection<AbstractRestrictionModel>	getRestrictionsForPage(AbstractPageModel page) Returns all restrictions which are applied on the given page
Collection<AbstractRestrictionModel>	getRestrictionsForPage(AbstractPageModel page, String restrictionType) Returns all restrictions of the given restriction type which are applied on the given page
Collection<AbstractRestrictionModel>	getRestrictionsForPage(String id, String restrictionType) Returns all restrictions of the given restriction type which are applied on the given page (via its id)
boolean	hasOtherRelations(AbstractRestrictionModel restriction, AbstractPageModel page) Checks if a given restriction has also other relations than to the given page
boolean	hasOtherRelations(String restrictionId, String pageId) Checks if a given restriction has also other relations than to the given page
protected void	prepareRestricion(AbstractRestrictionModel res, String id, String name)
void	setCategoryService(CategoryService categoryService)
void	setCmsAdminPageService(CMSAdminPageService cmsAdminPageService)
void	setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)
void	setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setI18nService(I18NService i18nService)
void	setProductService(ProductService productService)
void	setTypeService(TypeService typeService)
void	setUserService(UserService userService)

Methods inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService

getActiveCatalogVersion, getActiveSite, getUserService

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, setTenantScope, writeReplace

Methods inherited from class java.lang.Object

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

Field Detail

typeService

@Deprecated
protected TypeService typeService

Deprecated. Implement the TypeService as own property

productService

@Deprecated
protected ProductService productService

Deprecated. Implement the ProductService as own property

categoryService

@Deprecated
protected CategoryService categoryService

Deprecated. Implement the CategoryService as own property

cmsAdminPageService

@Deprecated
protected CMSAdminPageService cmsAdminPageService

Deprecated. Implement the CMSAdminPageService as own property

cmsRestrictionDao

@Deprecated
protected CMSRestrictionDao cmsRestrictionDao

Deprecated. Implement the CMSRestrictionDao as own property

Constructor Detail

DefaultCMSAdminRestrictionService

public DefaultCMSAdminRestrictionService()

Method Detail

getAllRestrictionTypes

public Collection<RestrictionTypeModel> getAllRestrictionTypes()

Description copied from interface: CMSAdminRestrictionService

Returns a collection of all available restriction types.

Specified by:

getAllRestrictionTypes in interface CMSAdminRestrictionService

Returns:

collection of all restriction types; never null

createCatalogRestriction

public CMSCatalogRestrictionModel createCatalogRestriction(AbstractPageModel page,
                                                           String id,
                                                           String name,
                                                           Collection<CatalogModel> catalogs)
                                                    throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new CatalogRestriction and a new relation between the restriction and the given page.

Specified by:

createCatalogRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

catalogs - list of catalogs for this restriction

Returns:

a new catalog restriction

Throws:

CMSItemCreateException - if the restriction could not be created

createCategoryRestriction

public CMSCategoryRestrictionModel createCategoryRestriction(AbstractPageModel page,
                                                             String id,
                                                             String name,
                                                             Collection<CategoryModel> categories)
                                                      throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new CategoryRestriction and a new relation between the restriction and the given page

Specified by:

createCategoryRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

categories - list of categories for this restriction

Returns:

a new category restriction

Throws:

CMSItemCreateException - if the restriction could not be created

createProductRestriction

public CMSProductRestrictionModel createProductRestriction(AbstractPageModel page,
                                                           String id,
                                                           String name,
                                                           Collection<ProductModel> products)
                                                    throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new ProductRestriction and a new relation between the restriction and the given page

Specified by:

createProductRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

products - list of products for this restriction

Returns:

a new product restriction

Throws:

CMSItemCreateException - if the restriction could not be created

createRelation

public void createRelation(AbstractPageModel page,
                           AbstractRestrictionModel restriction)

Description copied from interface: CMSAdminRestrictionService

creates a new relation between the given page and the given restriction

Specified by:

createRelation in interface CMSAdminRestrictionService

createRelation

public void createRelation(String pageId,
                           String restrictionId)
                    throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

creates a new relation between the given page (pageId) and the given restriction (restrictionId)

Specified by:

createRelation in interface CMSAdminRestrictionService

Throws:

CMSItemNotFoundException - if the page and/or restriction is not found

createTimeRestriction

public CMSTimeRestrictionModel createTimeRestriction(AbstractPageModel page,
                                                     String id,
                                                     String name,
                                                     Date from,
                                                     Date until)
                                              throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new TimeRestriction and a new relation between the restriction and the given page

Specified by:

createTimeRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

from - restriction is active from

until - restriction is active until

Returns:

a new time restriction

Throws:

CMSItemCreateException - if the restriction could not be created

createUserGroupRestriction

public CMSUserGroupRestrictionModel createUserGroupRestriction(AbstractPageModel page,
                                                               String id,
                                                               String name,
                                                               Collection<UserGroupModel> userGroups)
                                                        throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new UserGroupRestriction and a new relation between the restriction and the given page

Specified by:

createUserGroupRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

userGroups - list of user groups for this restriction

Returns:

a new user group restriction

Throws:

CMSItemCreateException - if the restriction could not be created

createUserRestriction

public CMSUserRestrictionModel createUserRestriction(AbstractPageModel page,
                                                     String id,
                                                     String name,
                                                     Collection<UserModel> users)
                                              throws CMSItemCreateException

Description copied from interface: CMSAdminRestrictionService

Creates a new UserRestriction and a new relation between the restriction and the given page

Specified by:

createUserRestriction in interface CMSAdminRestrictionService

Parameters:

page - page to be linked to the new restriction

id - id of the restriction

name - name of the restriction

users - list of users for this restriction

Returns:

a new user restriction

Throws:

CMSItemCreateException - if the restriction could not be created

deleteRelation

public void deleteRelation(AbstractRestrictionModel restriction,
                           AbstractPageModel page)

Description copied from interface: CMSAdminRestrictionService

deletes the relation between the restriction and the page

Specified by:

deleteRelation in interface CMSAdminRestrictionService

deleteRelation

public void deleteRelation(String restrictionId,
                           String pageId)
                    throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

deletes the relation between the restriction and the page

Specified by:

deleteRelation in interface CMSAdminRestrictionService

Throws:

CMSItemNotFoundException - if the restriction and/or page is not found

getAllowedRestrictionTypesForPage

public Collection<RestrictionTypeModel> getAllowedRestrictionTypesForPage(AbstractPageModel page)

Description copied from interface: CMSAdminRestrictionService

Returns a collection of all restrictions which can be applied on the given page

Specified by:

getAllowedRestrictionTypesForPage in interface CMSAdminRestrictionService

Returns:

all restriction types applicable for a given page

getAllowedRestrictionTypesForPage

public Collection<RestrictionTypeModel> getAllowedRestrictionTypesForPage(String id)
                                                                   throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns a collection of all restrictions which can be applied on the given page (via its id)

Specified by:

getAllowedRestrictionTypesForPage in interface CMSAdminRestrictionService

Parameters:

id - id of page

Returns:

all restriction types applicable for a given page

Throws:

CMSItemNotFoundException - if the page is not found

getAllRestrictionsByType

public Collection<AbstractRestrictionModel> getAllRestrictionsByType(String restrictionType)
                                                              throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns all restriction of the given restriction type

Specified by:

getAllRestrictionsByType in interface CMSAdminRestrictionService

Parameters:

restrictionType - ComposedType code of restriction

Returns:

all restrictions for a given restriction type

Throws:

CMSItemNotFoundException - if the composed type is not found

getAllRestrictionsByTypeNotLinkedToPage

public Collection<AbstractRestrictionModel> getAllRestrictionsByTypeNotLinkedToPage(String pageId,
                                                                                    String restrictionType)
                                                                             throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns all restrictions of the given restriction type which are currently not linked to the given page (via its id)

Specified by:

getAllRestrictionsByTypeNotLinkedToPage in interface CMSAdminRestrictionService

Parameters:

pageId - id of the page

restrictionType - composed type code of restriction

Returns:

all restrictions of a given restriction type which are not currently linked to a given page

Throws:

CMSItemNotFoundException - if the page or the composed type is not found

getCategories

public List<CategoryModel> getCategories(CMSCategoryRestrictionModel categoryRestriction,
                                         PreviewDataModel previewContext)

Description copied from interface: CMSAdminRestrictionService

Returns products for product restriction

Specified by:

getCategories in interface CMSAdminRestrictionService

Parameters:

categoryRestriction - given restriction

previewContext - preview context information

Returns:

products attached to productRestriction

getProducts

public List<ProductModel> getProducts(CMSProductRestrictionModel productRestriction,
                                      PreviewDataModel previewContext)

Description copied from interface: CMSAdminRestrictionService

Returns products for product restriction

Specified by:

getProducts in interface CMSAdminRestrictionService

Parameters:

productRestriction - given restriction

previewContext - preview context information

Returns:

products attached to productRestriction

getRestriction

public AbstractRestrictionModel getRestriction(String id)
                                        throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns a restriction via its id

Specified by:

getRestriction in interface CMSAdminRestrictionService

Parameters:

id - id of restriction

Returns:

the restriction for a given id

Throws:

CMSItemNotFoundException - if no restriction with the given id is found

getRestrictionsByName

public List<AbstractRestrictionModel> getRestrictionsByName(String name)
                                                     throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns a restriction via its name

Specified by:

getRestrictionsByName in interface CMSAdminRestrictionService

Parameters:

name - name of restriction

Returns:

the restriction for a given name

Throws:

CMSItemNotFoundException - if no restriction with the given name is found

getRestrictionsForPage

public Collection<AbstractRestrictionModel> getRestrictionsForPage(AbstractPageModel page,
                                                                   String restrictionType)
                                                            throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns all restrictions of the given restriction type which are applied on the given page

Specified by:

getRestrictionsForPage in interface CMSAdminRestrictionService

restrictionType - ComposedType code of restriction

Returns:

all restrictions applied for a given page

Throws:

CMSItemNotFoundException

getRestrictionsForPage

public Collection<AbstractRestrictionModel> getRestrictionsForPage(String id,
                                                                   String restrictionType)
                                                            throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Returns all restrictions of the given restriction type which are applied on the given page (via its id)

Specified by:

getRestrictionsForPage in interface CMSAdminRestrictionService

Parameters:

id - id of page

restrictionType - ComposedType code of restriction

Returns:

all restrictions applied for a given page

Throws:

CMSItemNotFoundException - if the page or the composed type is not found

hasOtherRelations

public boolean hasOtherRelations(AbstractRestrictionModel restriction,
                                 AbstractPageModel page)

Description copied from interface: CMSAdminRestrictionService

Checks if a given restriction has also other relations than to the given page

Specified by:

hasOtherRelations in interface CMSAdminRestrictionService

Returns:

true if there are also other relations, otherwise false

hasOtherRelations

public boolean hasOtherRelations(String restrictionId,
                                 String pageId)
                          throws CMSItemNotFoundException

Description copied from interface: CMSAdminRestrictionService

Checks if a given restriction has also other relations than to the given page

Specified by:

hasOtherRelations in interface CMSAdminRestrictionService

Returns:

true if there are also other relations, otherwise false

Throws:

CMSItemNotFoundException - if the restriction and/or page is not found

getAllRestrictions

public Collection<AbstractRestrictionModel> getAllRestrictions()

Description copied from interface: CMSAdminRestrictionService

Returns all restriction

Specified by:

getAllRestrictions in interface CMSAdminRestrictionService

Returns:

collection of restrictions; never null

getRestrictionsForPage

public Collection<AbstractRestrictionModel> getRestrictionsForPage(AbstractPageModel page)

Description copied from interface: CMSAdminRestrictionService

Returns all restrictions which are applied on the given page

Specified by:

getRestrictionsForPage in interface CMSAdminRestrictionService

Parameters:

page - - the page for which we want to retrieve restrictions

Returns:

all restrictions applied for a given page

setCategoryService

public void setCategoryService(CategoryService categoryService)

setCmsAdminPageService

public void setCmsAdminPageService(CMSAdminPageService cmsAdminPageService)

setCmsRestrictionDao

public void setCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao)

getCmsRestrictionDao

protected CMSRestrictionDao getCmsRestrictionDao()

setCmsRestrictionService

public void setCmsRestrictionService(CMSRestrictionService cmsRestrictionService)

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

setI18nService

public void setI18nService(I18NService i18nService)

setProductService

public void setProductService(ProductService productService)

setTypeService

public void setTypeService(TypeService typeService)

setUserService

public void setUserService(UserService userService)

Overrides:

setUserService in class AbstractCMSAdminService

getComposedTypeModel

protected ComposedTypeModel getComposedTypeModel(String composedType)
                                          throws CMSItemNotFoundException

Throws:

CMSItemNotFoundException

getLocalLocale

protected Locale getLocalLocale(PreviewDataModel previewContext)

getLocalUser

protected UserModel getLocalUser(PreviewDataModel previewContext)

prepareRestricion

protected void prepareRestricion(AbstractRestrictionModel res,
                                 String id,
                                 String name)
                          throws CMSItemCreateException

Throws:

CMSItemCreateException