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,org.springframework.beans.factory.Aware,org.springframework.beans.factory.BeanNameAware,org.springframework.beans.factory.InitializingBean
public class DefaultCMSAdminRestrictionService
extends AbstractCMSAdminService
implements CMSAdminRestrictionService
Default implementation of the restriction service.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService
AbstractService.SerializableDTO -
Field Summary
FieldsFields inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService
ACTIVECATALOGVERSION, ACTIVESITE, CLONE_CONTEXT, ORIGINAL_ITEM_CONTEXT, RESTORE_CONTEXT, TYPE_CONTEXTFields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService
modelService, sessionService, txManagerFields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService
tenant -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateCampaignRestriction(AbstractPageModel page, String id, String name, Collection<CampaignModel> campaigns) Creates a new CampaignRestriction and a new relation between the restriction and the given pagecreateCatalogRestriction(AbstractPageModel page, String id, String name, Collection<CatalogModel> catalogs) Creates a new CatalogRestriction and a new relation between the restriction and the given page.createCategoryRestriction(AbstractPageModel page, String id, String name, Collection<CategoryModel> categories) Creates a new CategoryRestriction and a new relation between the restriction and the given pagecreateProductRestriction(AbstractPageModel page, String id, String name, Collection<ProductModel> products) Creates a new ProductRestriction and a new relation between the restriction and the given pagevoidcreateRelation(AbstractPageModel page, AbstractRestrictionModel restriction) creates a new relation between the given page and the given restrictionvoidcreateRelation(String pageId, String restrictionId) creates a new relation between the given page (pageId) and the given restriction (restrictionId)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 pagecreateUserGroupRestriction(AbstractPageModel page, String id, String name, Collection<UserGroupModel> userGroups) Creates a new UserGroupRestriction and a new relation between the restriction and the given pagecreateUserRestriction(AbstractPageModel page, String id, String name, Collection<UserModel> users) Creates a new UserRestriction and a new relation between the restriction and the given pagevoiddeleteRelation(AbstractRestrictionModel restriction, AbstractPageModel page) deletes the relation between the restriction and the pagevoiddeleteRelation(String restrictionId, String pageId) deletes the relation between the restriction and the pageprotected voidfindCategoriesInLocalSession(PreviewDataModel previewContext, List<CategoryModel> ret, Collection<String> categoryListCodes) protected voidfindProductsInLocalSession(PreviewDataModel previewContext, List<ProductModel> ret, Collection<String> productListCodes) Returns a collection of all restrictions which can be applied on the given pageReturns a collection of all restrictions which can be applied on the given page (via its id)Returns all restrictiongetAllRestrictionsByType(String restrictionType) Returns all restriction of the given restriction typegetAllRestrictionsByTypeNotLinkedToPage(String pageId, String restrictionType) Returns all restrictions of the given restriction type which are currently not linked to the given page (via its id)Returns a collection of all available restriction types.getCategories(CMSCategoryRestrictionModel categoryRestriction, PreviewDataModel previewContext) Returns products for product restrictionprotected CategoryServiceprotected CMSAdminPageServiceprotected CMSRestrictionDaoprotected CMSRestrictionServiceprotected CommonI18NServiceprotected ComposedTypeModelgetComposedTypeModel(String composedType) protected I18NServiceprotected LocalegetLocalLocale(PreviewDataModel previewContext) protected UserModelgetLocalUser(PreviewDataModel previewContext) getProducts(CMSProductRestrictionModel productRestriction, PreviewDataModel previewContext) Returns products for product restrictionprotected ProductServicegetRestriction(String id) Returns a restriction via its idgetRestrictionsByName(String name) Returns a restriction via its nameReturns all restrictions which are applied on the given pagegetRestrictionsForPage(AbstractPageModel page, String restrictionType) Returns all restrictions of the given restriction type which are applied on the given pagegetRestrictionsForPage(String id, String restrictionType) Returns all restrictions of the given restriction type which are applied on the given page (via its id)protected TypeServicebooleanhasOtherRelations(AbstractRestrictionModel restriction, AbstractPageModel page) Checks if a given restriction has also other relations than to the given pagebooleanhasOtherRelations(String restrictionId, String pageId) Checks if a given restriction has also other relations than to the given pagebooleanDetermines if the given page has any restrictions assigned to it or notprotected voidprepareRestricion(AbstractRestrictionModel res, String id, String name) voidsetCategoryService(CategoryService categoryService) voidsetCmsAdminPageService(CMSAdminPageService cmsAdminPageService) voidsetCmsRestrictionDao(CMSRestrictionDao cmsRestrictionDao) voidsetCmsRestrictionService(CMSRestrictionService cmsRestrictionService) voidsetCommonI18NService(CommonI18NService commonI18NService) voidsetI18nService(I18NService i18nService) voidsetProductService(ProductService productService) voidsetTypeService(TypeService typeService) Methods inherited from class de.hybris.platform.cms2.servicelayer.services.admin.impl.AbstractCMSAdminService
getActiveCatalogVersion, getActiveSite, getBaseSiteService, getUserService, setBaseSiteService, setUserServiceMethods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService
getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManagerMethods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService
afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace
-
Field Details
-
CATALOG_VERSIONS
- See Also:
-
-
Constructor Details
-
DefaultCMSAdminRestrictionService
public DefaultCMSAdminRestrictionService()
-
-
Method Details
-
getAllRestrictionTypes
Description copied from interface:CMSAdminRestrictionServiceReturns a collection of all available restriction types.- Specified by:
getAllRestrictionTypesin interfaceCMSAdminRestrictionService- 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:CMSAdminRestrictionServiceCreates a new CatalogRestriction and a new relation between the restriction and the given page.- Specified by:
createCatalogRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictioncatalogs- 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:CMSAdminRestrictionServiceCreates a new CategoryRestriction and a new relation between the restriction and the given page- Specified by:
createCategoryRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictioncategories- 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:CMSAdminRestrictionServiceCreates a new ProductRestriction and a new relation between the restriction and the given page- Specified by:
createProductRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictionproducts- list of products for this restriction- Returns:
- a new product restriction
- Throws:
CMSItemCreateException- if the restriction could not be created
-
createRelation
Description copied from interface:CMSAdminRestrictionServicecreates a new relation between the given page and the given restriction- Specified by:
createRelationin interfaceCMSAdminRestrictionService- Parameters:
page- the page modelrestriction- the restriction model
-
createRelation
Description copied from interface:CMSAdminRestrictionServicecreates a new relation between the given page (pageId) and the given restriction (restrictionId)- Specified by:
createRelationin interfaceCMSAdminRestrictionService- Parameters:
pageId- the page idrestrictionId- the restriciton id- 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:CMSAdminRestrictionServiceCreates a new TimeRestriction and a new relation between the restriction and the given page- Specified by:
createTimeRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictionfrom- restriction is active fromuntil- 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:CMSAdminRestrictionServiceCreates a new UserGroupRestriction and a new relation between the restriction and the given page- Specified by:
createUserGroupRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictionuserGroups- 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:CMSAdminRestrictionServiceCreates a new UserRestriction and a new relation between the restriction and the given page- Specified by:
createUserRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictionusers- list of users for this restriction- Returns:
- a new user restriction
- Throws:
CMSItemCreateException- if the restriction could not be created
-
createCampaignRestriction
public CMSCampaignRestrictionModel createCampaignRestriction(AbstractPageModel page, String id, String name, Collection<CampaignModel> campaigns) throws CMSItemCreateException Description copied from interface:CMSAdminRestrictionServiceCreates a new CampaignRestriction and a new relation between the restriction and the given page- Specified by:
createCampaignRestrictionin interfaceCMSAdminRestrictionService- Parameters:
page- page to be linked to the new restrictionid- id of the restrictionname- name of the restrictioncampaigns- list of campaigns for this restriction- Returns:
- a new campaign restriction
- Throws:
CMSItemCreateException- if the restriction could not be created
-
deleteRelation
Description copied from interface:CMSAdminRestrictionServicedeletes the relation between the restriction and the page- Specified by:
deleteRelationin interfaceCMSAdminRestrictionService- Parameters:
restriction- the restriciton modelpage- the page model
-
deleteRelation
Description copied from interface:CMSAdminRestrictionServicedeletes the relation between the restriction and the page- Specified by:
deleteRelationin interfaceCMSAdminRestrictionService- Parameters:
restrictionId- the restriction idpageId- the page id- Throws:
CMSItemNotFoundException- if the restriction and/or page is not found
-
getAllowedRestrictionTypesForPage
Description copied from interface:CMSAdminRestrictionServiceReturns a collection of all restrictions which can be applied on the given page- Specified by:
getAllowedRestrictionTypesForPagein interfaceCMSAdminRestrictionService- Parameters:
page- the page model- Returns:
- all restriction types applicable for a given page
-
getAllowedRestrictionTypesForPage
public Collection<RestrictionTypeModel> getAllowedRestrictionTypesForPage(String id) throws CMSItemNotFoundException Description copied from interface:CMSAdminRestrictionServiceReturns a collection of all restrictions which can be applied on the given page (via its id)- Specified by:
getAllowedRestrictionTypesForPagein interfaceCMSAdminRestrictionService- 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:CMSAdminRestrictionServiceReturns all restriction of the given restriction type- Specified by:
getAllRestrictionsByTypein interfaceCMSAdminRestrictionService- 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:CMSAdminRestrictionServiceReturns all restrictions of the given restriction type which are currently not linked to the given page (via its id)- Specified by:
getAllRestrictionsByTypeNotLinkedToPagein interfaceCMSAdminRestrictionService- Parameters:
pageId- id of the pagerestrictionType- 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:CMSAdminRestrictionServiceReturns products for product restriction- Specified by:
getCategoriesin interfaceCMSAdminRestrictionService- Parameters:
categoryRestriction- given restrictionpreviewContext- preview context information- Returns:
- products attached to productRestriction
-
findCategoriesInLocalSession
protected void findCategoriesInLocalSession(PreviewDataModel previewContext, List<CategoryModel> ret, Collection<String> categoryListCodes) -
getProducts
public List<ProductModel> getProducts(CMSProductRestrictionModel productRestriction, PreviewDataModel previewContext) Description copied from interface:CMSAdminRestrictionServiceReturns products for product restriction- Specified by:
getProductsin interfaceCMSAdminRestrictionService- Parameters:
productRestriction- given restrictionpreviewContext- preview context information- Returns:
- products attached to productRestriction
-
findProductsInLocalSession
protected void findProductsInLocalSession(PreviewDataModel previewContext, List<ProductModel> ret, Collection<String> productListCodes) -
getRestriction
Description copied from interface:CMSAdminRestrictionServiceReturns a restriction via its id- Specified by:
getRestrictionin interfaceCMSAdminRestrictionService- 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:CMSAdminRestrictionServiceReturns a restriction via its name- Specified by:
getRestrictionsByNamein interfaceCMSAdminRestrictionService- 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:CMSAdminRestrictionServiceReturns all restrictions of the given restriction type which are applied on the given page- Specified by:
getRestrictionsForPagein interfaceCMSAdminRestrictionService- Parameters:
page- the page modelrestrictionType- ComposedType code of restriction- Returns:
- all restrictions applied for a given page
- Throws:
CMSItemNotFoundException- if the page or the composed type is not found
-
getRestrictionsForPage
public Collection<AbstractRestrictionModel> getRestrictionsForPage(String id, String restrictionType) throws CMSItemNotFoundException Description copied from interface:CMSAdminRestrictionServiceReturns all restrictions of the given restriction type which are applied on the given page (via its id)- Specified by:
getRestrictionsForPagein interfaceCMSAdminRestrictionService- Parameters:
id- id of pagerestrictionType- 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
Description copied from interface:CMSAdminRestrictionServiceChecks if a given restriction has also other relations than to the given page- Specified by:
hasOtherRelationsin interfaceCMSAdminRestrictionService- Parameters:
restriction- the restriciton modelpage- the page model- Returns:
- true if there are also other relations, otherwise false
-
hasOtherRelations
public boolean hasOtherRelations(String restrictionId, String pageId) throws CMSItemNotFoundException Description copied from interface:CMSAdminRestrictionServiceChecks if a given restriction has also other relations than to the given page- Specified by:
hasOtherRelationsin interfaceCMSAdminRestrictionService- Parameters:
restrictionId- the restriction idpageId- the page id- Returns:
- true if there are also other relations, otherwise false
- Throws:
CMSItemNotFoundException- if the restriction and/or page is not found
-
getAllRestrictions
Description copied from interface:CMSAdminRestrictionServiceReturns all restriction- Specified by:
getAllRestrictionsin interfaceCMSAdminRestrictionService- Returns:
- collection of restrictions; never
null
-
getRestrictionsForPage
Description copied from interface:CMSAdminRestrictionServiceReturns all restrictions which are applied on the given page- Specified by:
getRestrictionsForPagein interfaceCMSAdminRestrictionService- Parameters:
page- - the page for which we want to retrieve restrictions- Returns:
- all restrictions applied for a given page
-
hasPageRestrictions
Description copied from interface:CMSAdminRestrictionServiceDetermines if the given page has any restrictions assigned to it or not- Specified by:
hasPageRestrictionsin interfaceCMSAdminRestrictionService- Parameters:
page- - the page for which we want to verify the restrictions relations- Returns:
TRUEwhen the page contains at least one restriction; otherwiseFALSE
-
getCategoryService
-
setCategoryService
-
getCmsAdminPageService
-
setCmsAdminPageService
-
getCmsRestrictionDao
-
setCmsRestrictionDao
-
getCmsRestrictionService
-
setCmsRestrictionService
-
getCommonI18NService
-
setCommonI18NService
-
getI18nService
-
setI18nService
-
getProductService
-
setProductService
-
getTypeService
-
setTypeService
-
getComposedTypeModel
protected ComposedTypeModel getComposedTypeModel(String composedType) throws CMSItemNotFoundException - Throws:
CMSItemNotFoundException
-
getLocalLocale
-
getLocalUser
-
prepareRestricion
protected void prepareRestricion(AbstractRestrictionModel res, String id, String name) throws CMSItemCreateException - Throws:
CMSItemCreateException
-