de.hybris.platform.printcockpit.model.publication

Interface PublicationService

All Known Implementing Classes:

PublicationServiceImpl

public interface PublicationService

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_RECENTLY

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
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 pageModel, 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.
ItemModel	getParent(Object object)
<T extends ItemModel,C extends Collection<T>> C	getReadableElements(C publications) Returns filtered publication elements
List<PublicationModel>	getRecentlyOpened() get a list of recently opened publications
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.
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

Field Detail

MAX_RECENTLY

static final int MAX_RECENTLY

See Also:

Constant Field Values

Method Detail

getExistingPublications

List<PublicationModel> getExistingPublications(boolean onlyActive)

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.

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.

loadPublication

PublicationModel loadPublication(PublicationModel selected)

Called to load a selected publication into print cockpit.

Parameters:

selected - the publication to load

Returns:

the loaded publication

loadPublicationForChooser

PublicationModel loadPublicationForChooser(PK selected)

Called to load a selected publication into print cockpit.

Parameters:

selected - PK of the publication to load

Returns:

the loaded publication

deletePublication

void deletePublication(PublicationModel publication)

Completely deletes a publication from database

Parameters:

publication - the publication to delete

deleteElements

void deleteElements(List<Object> elements)

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

Parameters:

elements -

getAvailablePublicationStates

List<HybrisEnumValue> getAvailablePublicationStates()

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

getAvailableChapterStates

List<HybrisEnumValue> getAvailableChapterStates()

getAvailablePageStates

List<HybrisEnumValue> getAvailablePageStates()

getAvailablePlacementStates

List<HybrisEnumValue> getAvailablePlacementStates()

getAvailableFileHandlingModes

List<HybrisEnumValue> getAvailableFileHandlingModes()

Returns all enums to be used as filehandling modes.

createPlacement

ItemPlacementModel createPlacement(PageModel pageModel,
                                   ItemModel item)

Creates a new placement

Parameters:

pageModel - the page in which the placement shall reside

item - item to be set inside created placement

Returns:

the new placement

createPublication

PublicationModel createPublication()

Creates a new publication

createPublication

PublicationModel createPublication(PublicationModel templatePublication)

Creates a new publication as a copy of an existing one

Parameters:

templatePublication - the existing publication to be cloned

Returns:

the new publication

createPublication

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

Creates a new publication with an initial chapter/pages structure

Parameters:

initialRootChapters - the number of initial rootchapters

pagesPerRootChapter - the number of pages per rootchapter

ctx - additional parameters

Returns:

the new publication

createChapter

ChapterModel createChapter(PublicationModel publication)

Creates a new chapter

Parameters:

publication - the publication the new chapter belongs to

Returns:

the new chapter

createPage

PageModel createPage(PublicationModel publication,
                     ChapterModel chapter)

Creates a new page

Parameters:

publication - the publication the new page belongs to

Returns:

the new page

clonePlacement

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. If no publication/page is provided then publication/page from original placement is taken.

Parameters:

_publication -

_page -

originalPlacement -

Returns:

cloned placement

cloneChapter

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

Creates a copy of a chapter

Parameters:

_publication - the publication the new chapter belongs to

superChapter -

originalChapter - the chapter to clone

clonePage

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. If no publication/chapter is provided then publication/chapter from original page is taken.

Parameters:

_publication -

_chapter -

originalPage -

Returns:

cloned page

convertSearchResult

ListSearchResult convertSearchResult(ListSearchResult result,
                                     PublicationModel pub)

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

Parameters:

result - the original search result

Returns:

the converted search result

autoCreateCodeString

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

Parameters:

itemclass - the element

publication - the selected publication

Returns:

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

getAvailablePlaceholderTemplates

List<String> getAvailablePlaceholderTemplates()

get all available placeholder templates

Returns:

the list of available placeholder templates

loadTemplate

PlaceholderTemplateModel loadTemplate(String code)

get the placeholder template with the given code

Parameters:

code - the code

Returns:

the placeholder template

getRecentlyOpened

List<PublicationModel> getRecentlyOpened()

get a list of recently opened publications

Returns:

the list of recently opened publications

addRecentlyOpened

void addRecentlyOpened(PublicationModel pub)

add a publication to the list of recently opened publications

Parameters:

pub - the publication to add

getDefaultCometConfiguration

CometConfigurationModel getDefaultCometConfiguration()

get the default comet configuration

Returns:

the default comet configuration

checkAccessPermission

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

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

Parameters:

item - the item

userright - the userright

Returns:

true, if access right is granted

isWritable

@Deprecated
boolean isWritable(ItemModel item)

Deprecated.

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

Parameters:

item -

Returns:

true if user has proper permission

isWritable

boolean isWritable(ItemModel item,
                   boolean recursive)

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

Parameters:

item -

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

Returns:

true if user has proper permission

isReadable

@Deprecated
boolean isReadable(ItemModel item,
                               Principal principal)

Deprecated.

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

Parameters:

item -

Returns:

true if user has proper permission

getReadableElements

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

Returns filtered publication elements

Parameters:

publications -

Returns:

readable publications for given user

getDefaultPageAttributeValuesMap

void getDefaultPageAttributeValuesMap(Map<String,Object> attr)

isCodeInUse

boolean isCodeInUse(PublicationModel publication,
                    String code)

mustFixPlacements

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

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

Parameters:

grid - the grid

gridMode - the gridmode

Returns:

true, if all placements have valid ids, false otherwise

autoAssignPlacements

void autoAssignPlacements(PageModel page)

getAllRegisteredElements

List<Object> getAllRegisteredElements(PublicationModel publicationModel)

getAllPages

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

Parameters:

chapters -

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

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

Parameters:

pages -

Returns:

all placements for given pages

getParent

ItemModel getParent(Object object)

Parameters:

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

Returns:

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

getChildren

Collection<ItemModel> getChildren(Object object)

Parameters:

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

Returns:

children

isSubelement

boolean isSubelement(TypedObject parent,
                     TypedObject elementToCheck)

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

Parameters:

parent -

elementToCheck -

Returns:

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