de.hybris.platform.printcockpit.model.publication.impl

Class PublicationServiceImpl

java.lang.Object

de.hybris.platform.printcockpit.model.general.impl.AbstractServiceImpl

de.hybris.platform.printcockpit.model.publication.impl.PublicationServiceImpl

All Implemented Interfaces:

PublicationService

public class PublicationServiceImpl
extends AbstractServiceImpl
implements PublicationService

Field Summary

Fields

Modifier and Type	Field and Description
static String	PRINTCOCKPIT_RECENTLY_OPENED_PROPERTY

Fields inherited from interface de.hybris.platform.printcockpit.model.publication.PublicationService

MAX_RECENTLY

Constructor Summary

Constructors

Constructor and Description
PublicationServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addRecentlyOpened(PublicationModel pub) add a publication to the list of recently opened publications
void	autoAssignPlacements(PageModel page)
String	autoCreateCodeString(Class itemclass, String localized_code, PublicationModel publication) Automatically creates a string for the code of the element according to the number of already created items
boolean	checkAccessPermission(ItemModel item, String userright, boolean recursive) Check if the current user has the specified access right for an item
protected void	checkAndReplaceIDs(PublicationComponentModel element, PublicationModel publication, Set<String> ids)
ChapterModel	cloneChapter(PublicationModel _publication, ChapterModel superChapter, ChapterModel originalChapter) Creates a copy of a chapter
PageModel	clonePage(PublicationModel _publication, ChapterModel _chapter, PageModel originalPage) Clones given page, if publication and/or chapter are provided then new (cloned) page will have them assigned.
PlacementModel	clonePlacement(PublicationModel _publication, PageModel _page, PlacementModel originalPlacement) Clones given placement, if publication and/or page are provided then new (cloned) placement will have them assigned.
ListSearchResult	convertSearchResult(ListSearchResult result, PublicationModel pub) Convert a search result that contains PK-Strings into one with PublicationElementsModel
ChapterModel	createChapter(PublicationModel publication) Creates a new chapter
PageModel	createPage(PublicationModel publication, ChapterModel chapter) Creates a new page
ItemPlacementModel	createPlacement(PageModel page, ItemModel item) Creates a new placement
PublicationModel	createPublication() Creates a new publication
PublicationModel	createPublication(int initialRootChapters, int pagesPerRootChapter, Map<String,Object> ctx) Creates a new publication with an initial chapter/pages structure
PublicationModel	createPublication(PublicationModel templatePublication) Creates a new publication as a copy of an existing one
void	deleteElements(List<Object> elements) Called to delete a specified set of loaded elements e.g.
void	deletePublication(PublicationModel publication) Completely deletes a publication from database
Collection<PageModel>	getAllPages(Collection<ChapterModel> chapters)
Collection<PlacementModel>	getAllPlacements(Collection<PageModel> pages)
List<Object>	getAllRegisteredElements(PublicationModel publicationModel)
List<HybrisEnumValue>	getAvailableChapterStates()
List<HybrisEnumValue>	getAvailableFileHandlingModes() Returns all enums to be used as filehandling modes.
List<HybrisEnumValue>	getAvailablePageStates()
List<String>	getAvailablePlaceholderTemplates() get all available placeholder templates
List<HybrisEnumValue>	getAvailablePlacementStates()
List<HybrisEnumValue>	getAvailablePublicationStates() Returns all enums to be used as publication element status.
Collection<ItemModel>	getChildren(Object object)
CometConfigurationModel	getDefaultCometConfiguration() get the default comet configuration
void	getDefaultPageAttributeValuesMap(Map<String,Object> attr)
List<PublicationModel>	getExistingPublications(boolean onlyActive) Returns a list of existing publications.
protected int	getItemsToLoad(Publication p)
LayoutService	getLayoutService()
ModelHelper	getModelHelper()
ModelService	getModelService()
ItemModel	getParent(Object object)
PrintcockpitService	getPrintcockpitService()
<T extends ItemModel,C extends Collection<T>> C	getReadableElements(C publications) Returns filtered publication elements
<T extends ItemModel,C extends Collection<T>> C	getReadableElements(C publications, UserModel user) Returns filtered publication elements
protected Predicate	getReadablePredicator(UserModel user) Returns predicator for filtering the list
List<PublicationModel>	getRecentlyOpened() get a list of recently opened publications
TypeService	getTypeService()
PrintcockpitUIAccessRightService	getUiAccessRightService()
boolean	isCodeInUse(PublicationModel publication, String code)
boolean	isReadable(ItemModel item, Principal principal) Deprecated.
boolean	isSubelement(TypedObject parent, TypedObject elementToCheck) Checks if the given element is placed somewhere in the node as subelement of the given parent
boolean	isWritable(ItemModel item) Deprecated, use: PrintcockpitUIAccessRightService.canWrite(de.hybris.platform.core.model.user.UserModel, ItemModel) instead.
boolean	isWritable(ItemModel item, boolean recursive) Checks if current user has permission to write/change/delete specified publication node
PublicationModel	loadPublication(PublicationModel selected) Called to load a selected publication into print cockpit.
PublicationModel	loadPublicationForChooser(PK selected) Called to load a selected publication into print cockpit.
PlaceholderTemplateModel	loadTemplate(String code) get the placeholder template with the given code
boolean	mustFixPlacements(PageModel page, GridModel grid, HybrisEnumValue gridMode) check if all placements have valid gridelement ids for specified grid and gridmode
protected List<PK>	readRecentlyOpened()
protected String	renameIfNecessary(String val, PublicationModel publication)
protected void	replaceID(PublicationComponentModel p)
void	setLayoutService(LayoutService layoutService)
void	setModelHelper(ModelHelper modelHelper)
void	setModelService(ModelService modelService)
void	setPrintcockpitService(PrintcockpitService printcockpitService)
void	setTypeService(TypeService typeService)
void	setUiAccessRightService(PrintcockpitUIAccessRightService uiAccessRightService)
protected void	storePositions(ItemModel parent, List<ItemModel> oldList, List<ItemModel> newList, String parentAttr, String posAttr)
protected void	storePositionsComplete(ItemModel parent, List<ItemModel> oldList, List<ItemModel> newList, String parentAttr, String posAttr)
protected void	storePositionsDiff(ItemModel parent, List<ItemModel> oldList, List<ItemModel> newList, String parentAttr, String posAttr)
protected void	writeRecentlyOpened(List<PK> pks)

Methods inherited from class de.hybris.platform.printcockpit.model.general.impl.AbstractServiceImpl

getEnum, getEnums

Methods inherited from class java.lang.Object

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

Field Detail

PRINTCOCKPIT_RECENTLY_OPENED_PROPERTY

public static final String PRINTCOCKPIT_RECENTLY_OPENED_PROPERTY

See Also:

Constant Field Values

Constructor Detail

PublicationServiceImpl

public PublicationServiceImpl()

Method Detail

addRecentlyOpened

public void addRecentlyOpened(PublicationModel pub)

Description copied from interface: PublicationService

add a publication to the list of recently opened publications

Specified by:

addRecentlyOpened in interface PublicationService

Parameters:

pub - the publication to add

autoAssignPlacements

public void autoAssignPlacements(PageModel page)

Specified by:

autoAssignPlacements in interface PublicationService

autoCreateCodeString

public String autoCreateCodeString(Class itemclass,
                                   String localized_code,
                                   PublicationModel publication)

Description copied from interface: PublicationService

Automatically creates a string for the code of the element according to the number of already created items

Specified by:

autoCreateCodeString in interface PublicationService

Parameters:

itemclass - the element

publication - the selected publication

Returns:

a string usually containing the name of the element followed by a number

checkAccessPermission

public boolean checkAccessPermission(ItemModel item,
                                     String userright,
                                     boolean recursive)

Description copied from interface: PublicationService

Check if the current user has the specified access right for an item

Specified by:

checkAccessPermission in interface PublicationService

Parameters:

item - the item

userright - the userright

Returns:

true, if access right is granted

checkAndReplaceIDs

protected void checkAndReplaceIDs(PublicationComponentModel element,
                                  PublicationModel publication,
                                  Set<String> ids)

cloneChapter

public ChapterModel cloneChapter(PublicationModel _publication,
                                 ChapterModel superChapter,
                                 ChapterModel originalChapter)

Description copied from interface: PublicationService

Creates a copy of a chapter

Specified by:

cloneChapter in interface PublicationService

Parameters:

_publication - the publication the new chapter belongs to

originalChapter - the chapter to clone

clonePage

public PageModel clonePage(PublicationModel _publication,
                           ChapterModel _chapter,
                           PageModel originalPage)

Description copied from interface: PublicationService

Clones given page, if publication and/or chapter are provided then new (cloned) page will have them assigned. If no publication/chapter is provided then publication/chapter from original page is taken.

Specified by:

clonePage in interface PublicationService

Returns:

cloned page

clonePlacement

public PlacementModel clonePlacement(PublicationModel _publication,
                                     PageModel _page,
                                     PlacementModel originalPlacement)

Description copied from interface: PublicationService

Clones given placement, if publication and/or page are provided then new (cloned) placement will have them assigned. If no publication/page is provided then publication/page from original placement is taken.

Specified by:

clonePlacement in interface PublicationService

Returns:

cloned placement

convertSearchResult

public ListSearchResult convertSearchResult(ListSearchResult result,
                                            PublicationModel pub)

Description copied from interface: PublicationService

Convert a search result that contains PK-Strings into one with PublicationElementsModel

Specified by:

convertSearchResult in interface PublicationService

Parameters:

result - the original search result

Returns:

the converted search result

createChapter

public ChapterModel createChapter(PublicationModel publication)

Description copied from interface: PublicationService

Creates a new chapter

Specified by:

createChapter in interface PublicationService

Parameters:

publication - the publication the new chapter belongs to

Returns:

the new chapter

createPage

public PageModel createPage(PublicationModel publication,
                            ChapterModel chapter)

Description copied from interface: PublicationService

Creates a new page

Specified by:

createPage in interface PublicationService

Parameters:

publication - the publication the new page belongs to

Returns:

the new page

createPlacement

public ItemPlacementModel createPlacement(PageModel page,
                                          ItemModel item)

Description copied from interface: PublicationService

Creates a new placement

Specified by:

createPlacement in interface PublicationService

Parameters:

page - the page in which the placement shall reside

item - item to be set inside created placement

Returns:

the new placement

createPublication

public PublicationModel createPublication()

Description copied from interface: PublicationService

Creates a new publication

Specified by:

createPublication in interface PublicationService

createPublication

public PublicationModel createPublication(int initialRootChapters,
                                          int pagesPerRootChapter,
                                          Map<String,Object> ctx)

Description copied from interface: PublicationService

Creates a new publication with an initial chapter/pages structure

Specified by:

createPublication in interface PublicationService

Parameters:

initialRootChapters - the number of initial rootchapters

pagesPerRootChapter - the number of pages per rootchapter

ctx - additional parameters

Returns:

the new publication

createPublication

public PublicationModel createPublication(PublicationModel templatePublication)

Description copied from interface: PublicationService

Creates a new publication as a copy of an existing one

Specified by:

createPublication in interface PublicationService

Parameters:

templatePublication - the existing publication to be cloned

Returns:

the new publication

deleteElements

public void deleteElements(List<Object> elements)

Description copied from interface: PublicationService

Called to delete a specified set of loaded elements e.g. when emptying the trash bin.

Specified by:

deleteElements in interface PublicationService

deletePublication

public void deletePublication(PublicationModel publication)

Description copied from interface: PublicationService

Completely deletes a publication from database

Specified by:

deletePublication in interface PublicationService

Parameters:

publication - the publication to delete

getAllPages

public Collection<PageModel> getAllPages(Collection<ChapterModel> chapters)

Specified by:

getAllPages in interface PublicationService

Returns:

all pages for given chapters and their sub chapters (recursively). If user has no right to read particular page this page is excluded from returning collection.

getAllPlacements

public Collection<PlacementModel> getAllPlacements(Collection<PageModel> pages)

Specified by:

getAllPlacements in interface PublicationService

Returns:

all placements for given pages

getAllRegisteredElements

public List<Object> getAllRegisteredElements(PublicationModel publicationModel)

Specified by:

getAllRegisteredElements in interface PublicationService

getAvailableChapterStates

public List<HybrisEnumValue> getAvailableChapterStates()

Specified by:

getAvailableChapterStates in interface PublicationService

getAvailableFileHandlingModes

public List<HybrisEnumValue> getAvailableFileHandlingModes()

Description copied from interface: PublicationService

Returns all enums to be used as filehandling modes.

Specified by:

getAvailableFileHandlingModes in interface PublicationService

getAvailablePageStates

public List<HybrisEnumValue> getAvailablePageStates()

Specified by:

getAvailablePageStates in interface PublicationService

getAvailablePlaceholderTemplates

public List<String> getAvailablePlaceholderTemplates()

Description copied from interface: PublicationService

get all available placeholder templates

Specified by:

getAvailablePlaceholderTemplates in interface PublicationService

Returns:

the list of available placeholder templates

getAvailablePlacementStates

public List<HybrisEnumValue> getAvailablePlacementStates()

Specified by:

getAvailablePlacementStates in interface PublicationService

getAvailablePublicationStates

public List<HybrisEnumValue> getAvailablePublicationStates()

Description copied from interface: PublicationService

Returns all enums to be used as publication element status. @ see PublicationElementModel#getStatus() @ see PublicationElementModel#setStatus(HybrisEnumValue)

Specified by:

getAvailablePublicationStates in interface PublicationService

getChildren

public Collection<ItemModel> getChildren(Object object)

Specified by:

getChildren in interface PublicationService

Parameters:

object - ItemModel or TypedObject of the kind: Publication, Chapter, Page

Returns:

children

getDefaultCometConfiguration

public CometConfigurationModel getDefaultCometConfiguration()

Description copied from interface: PublicationService

get the default comet configuration

Specified by:

getDefaultCometConfiguration in interface PublicationService

Returns:

the default comet configuration

getDefaultPageAttributeValuesMap

public void getDefaultPageAttributeValuesMap(Map<String,Object> attr)

Specified by:

getDefaultPageAttributeValuesMap in interface PublicationService

getExistingPublications

public List<PublicationModel> getExistingPublications(boolean onlyActive)

Description copied from interface: PublicationService

Returns a list of existing publications.

These objects are not fully loaded publications but stripped down versions of them to be used for selection e.g. for loading or cloning them.

Specified by:

getExistingPublications in interface PublicationService

Parameters:

onlyActive - set to true if only active publications should be returned, set to false if all publication should be returned

Returns:

A list of all existing publications as beans, narrowed to publication that user has access to.

getItemsToLoad

protected int getItemsToLoad(Publication p)

getLayoutService

public LayoutService getLayoutService()

getModelService

public ModelService getModelService()

Overrides:

getModelService in class AbstractServiceImpl

getParent

public ItemModel getParent(Object object)

Specified by:

getParent in interface PublicationService

Parameters:

object - ItemModel or TypedObject of kind: Publication, Chapter, Page, Placement etc.

Returns:

parent of given item, if item is publication null is returned

getPrintcockpitService

public PrintcockpitService getPrintcockpitService()

getReadableElements

public <T extends ItemModel,C extends Collection<T>> C getReadableElements(C publications)

Returns filtered publication elements

Specified by:

getReadableElements in interface PublicationService

Parameters:

publications -

Returns:

readable publications for session user

getReadableElements

public <T extends ItemModel,C extends Collection<T>> C getReadableElements(C publications,
                                                                           UserModel user)

Returns filtered publication elements

Parameters:

publications -

user -

Returns:

readable publications for given user

getReadablePredicator

protected Predicate getReadablePredicator(UserModel user)

Returns predicator for filtering the list

Parameters:

user -

Returns:

Predicate instance

getRecentlyOpened

public List<PublicationModel> getRecentlyOpened()

Description copied from interface: PublicationService

get a list of recently opened publications

Specified by:

getRecentlyOpened in interface PublicationService

Returns:

the recentlyOpened

getTypeService

public TypeService getTypeService()

isCodeInUse

public boolean isCodeInUse(PublicationModel publication,
                           String code)

Specified by:

isCodeInUse in interface PublicationService

isReadable

@Deprecated
public boolean isReadable(ItemModel item,
                                      Principal principal)

Deprecated.

Description copied from interface: PublicationService

Deprecated, use: PrintcockpitUIAccessRightService.canRead(de.hybris.platform.core.model.user.UserModel, ItemModel) Checks if current user has permission to read specified publication node

Specified by:

isReadable in interface PublicationService

Returns:

true if user has proper permission

isSubelement

public boolean isSubelement(TypedObject parent,
                            TypedObject elementToCheck)

Description copied from interface: PublicationService

Checks if the given element is placed somewhere in the node as subelement of the given parent

Specified by:

isSubelement in interface PublicationService

Returns:

true if given elementToCheck lays somewhere as subelement of the given parent

isWritable

public boolean isWritable(ItemModel item)

Description copied from interface: PublicationService

Deprecated, use: PrintcockpitUIAccessRightService.canWrite(de.hybris.platform.core.model.user.UserModel, ItemModel) instead.
Checks if current user has permission to write/change/delete specified publication node

Specified by:

isWritable in interface PublicationService

Returns:

true if user has proper permission

isWritable

public boolean isWritable(ItemModel item,
                          boolean recursive)

Description copied from interface: PublicationService

Checks if current user has permission to write/change/delete specified publication node

Specified by:

isWritable in interface PublicationService

recursive - - if true all subelements will be checked as well

Returns:

true if user has proper permission

loadPublication

public PublicationModel loadPublication(PublicationModel selected)

Description copied from interface: PublicationService

Called to load a selected publication into print cockpit.

Specified by:

loadPublication in interface PublicationService

Parameters:

selected - the publication to load

Returns:

the loaded publication

loadPublicationForChooser

public PublicationModel loadPublicationForChooser(PK selected)

Description copied from interface: PublicationService

Called to load a selected publication into print cockpit.

Specified by:

loadPublicationForChooser in interface PublicationService

Parameters:

selected - PK of the publication to load

Returns:

the loaded publication

loadTemplate

public PlaceholderTemplateModel loadTemplate(String code)

Description copied from interface: PublicationService

get the placeholder template with the given code

Specified by:

loadTemplate in interface PublicationService

Parameters:

code - the code

Returns:

the placeholder template

mustFixPlacements

public boolean mustFixPlacements(PageModel page,
                                 GridModel grid,
                                 HybrisEnumValue gridMode)

Description copied from interface: PublicationService

check if all placements have valid gridelement ids for specified grid and gridmode

Specified by:

mustFixPlacements in interface PublicationService

grid - the grid

gridMode - the gridmode

Returns:

true, if all placements have valid ids, false otherwise

readRecentlyOpened

protected List<PK> readRecentlyOpened()

renameIfNecessary

protected String renameIfNecessary(String val,
                                   PublicationModel publication)

replaceID

protected void replaceID(PublicationComponentModel p)

setLayoutService

public void setLayoutService(LayoutService layoutService)

setModelService

public void setModelService(ModelService modelService)

Overrides:

setModelService in class AbstractServiceImpl

setPrintcockpitService

public void setPrintcockpitService(PrintcockpitService printcockpitService)

setTypeService

public void setTypeService(TypeService typeService)

storePositions

protected void storePositions(ItemModel parent,
                              List<ItemModel> oldList,
                              List<ItemModel> newList,
                              String parentAttr,
                              String posAttr)

storePositionsComplete

protected void storePositionsComplete(ItemModel parent,
                                      List<ItemModel> oldList,
                                      List<ItemModel> newList,
                                      String parentAttr,
                                      String posAttr)

storePositionsDiff

protected void storePositionsDiff(ItemModel parent,
                                  List<ItemModel> oldList,
                                  List<ItemModel> newList,
                                  String parentAttr,
                                  String posAttr)

writeRecentlyOpened

protected void writeRecentlyOpened(List<PK> pks)

getUiAccessRightService

public PrintcockpitUIAccessRightService getUiAccessRightService()

Returns:

the uiAccessRightService

setUiAccessRightService

public void setUiAccessRightService(PrintcockpitUIAccessRightService uiAccessRightService)

Parameters:

uiAccessRightService - the uiAccessRightService to set

setModelHelper

public void setModelHelper(ModelHelper modelHelper)

getModelHelper

public ModelHelper getModelHelper()