Class DefaultRelatedPageRejectionService
java.lang.Object
de.hybris.platform.cms2.relatedpages.service.impl.DefaultRelatedPageRejectionService
- All Implemented Interfaces:
RelatedPageRejectionService
public class DefaultRelatedPageRejectionService
extends Object
implements RelatedPageRejectionService
Default implementation of
RelatedPageRejectionService interface. The CmsApprovalStatus.CHECK is used as
unapprove status.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected CMSAdminSiteServiceprotected CMSVersionSessionContextProviderprotected CMSWorkflowServiceprotected ModelServiceprotected CmsApprovalStatusReturns original (before the change) approval status forAbstractPageModel.protected RelatedItemsServicebooleanVerifies whether the approval status was manually changed or not.protected booleanDetermines if the given page is the original item being modified by theCMSItemFacade.protected booleanDetermines if the given page exists in theCmsVersionSessionContextProvider.protected booleanDetermines if the page is in an active workflow or not.voidrejectAllRelatedPages(ItemModel itemModel) Deprecated, for removal: This API element is subject to removal in a future version.voidrejectAllRelatedPages(ItemModel itemModel, InterceptorContext interceptorContext) Rejects pages related to the given item.rejectPage(AbstractPageModel page) Unapproves the page.voidsetCmsAdminSiteService(CMSAdminSiteService cmsAdminSiteService) voidsetCmsVersionSessionContextProvider(CMSVersionSessionContextProvider cmsVersionSessionContextProvider) voidsetCmsWorkflowService(CMSWorkflowService cmsWorkflowService) voidsetModelService(ModelService modelService) voidsetPageTypePredicate(Predicate<ItemModel> pageTypePredicate) voidsetRelatedItemsService(RelatedItemsService relatedItemsService) protected booleanVerifies whether a page should have its approval status changed to CHECK and saved or not.
-
Constructor Details
-
DefaultRelatedPageRejectionService
public DefaultRelatedPageRejectionService()
-
-
Method Details
-
rejectAllRelatedPages
Description copied from interface:RelatedPageRejectionServiceRejects pages related to the given item.- Specified by:
rejectAllRelatedPagesin interfaceRelatedPageRejectionService- Parameters:
itemModel- theItemModelthat potentially has related pages to be rejected.interceptorContext- theInterceptorContextthe interceptor context.
-
rejectAllRelatedPages
Deprecated, for removal: This API element is subject to removal in a future version.since 2105, please userejectAllRelatedPages(ItemModel, InterceptorContext)instead.Rejects pages related to the given item.- Specified by:
rejectAllRelatedPagesin interfaceRelatedPageRejectionService- Parameters:
itemModel- theItemModelthat potentially has related pages to be rejected.
-
shouldRejectPage
Verifies whether a page should have its approval status changed to CHECK and saved or not.- Parameters:
page- the page to verify- Returns:
- TRUE if the page should be updated and saved, FALSE otherwise
-
notInActiveWorkflow
Determines if the page is in an active workflow or not.- Parameters:
page- the page to verify- Returns:
- TRUE if the page is not in any active workflow, FALSE otherwise
-
isRestoredPageVersion
Determines if the given page exists in theCmsVersionSessionContextProvider. If so, this means that the page is being restored from a version. Therefore, the page should be omitted from being saved in this service because it will be saved in the same transaction in another layer, otherwise aModelSavingExceptionwill occur.- Parameters:
page- the page to verify- Returns:
- TRUE if the page exists in the version session context, FALSE otherwise
-
isOriginalItem
Determines if the given page is the original item being modified by theCMSItemFacade. If so, the page should be omitted from being saved in this service because it will be saved in the same transaction in the facade layer, otherwise aStackOverflowExceptionmay occur.- Parameters:
page- the page to verify- Returns:
- TRUE if the page is the original item being modified in
CMSItemFacade, FALSE otherwise
-
hasUserChangedApprovalStatus
Description copied from interface:RelatedPageRejectionServiceVerifies whether the approval status was manually changed or not. For example, if the user changed the approval status from CHECK to APPROVED, the service should never change the approval status back to CHECK.- Specified by:
hasUserChangedApprovalStatusin interfaceRelatedPageRejectionService- Parameters:
page- the page to verify- Returns:
TRUEif approval status was manually changed,FALSEotherwise.
-
getOriginalApprovalStatus
Returns original (before the change) approval status forAbstractPageModel.- Parameters:
page- theAbstractPageModelto retrieve original approval status.- Returns:
- original approval status.
-
rejectPage
Unapproves the page. CHECK is used as a status.- Specified by:
rejectPagein interfaceRelatedPageRejectionService- Parameters:
page- theAbstractPageModelto unapprove.- Returns:
- page model with updated approval status.
-
getRelatedItemsService
-
getModelService
-
setModelService
-
getPageTypePredicate
-
setPageTypePredicate
-
getCmsWorkflowService
-
setCmsWorkflowService
-
getCmsVersionSessionContextProvider
-
setCmsVersionSessionContextProvider
public void setCmsVersionSessionContextProvider(CMSVersionSessionContextProvider cmsVersionSessionContextProvider) -
getCmsAdminSiteService
-
setCmsAdminSiteService
-
rejectAllRelatedPages(ItemModel, InterceptorContext)instead.