de.hybris.platform.printcockpitnew.services

Interface PrintcockpitService

All Known Implementing Classes:

DefaultPrintcockpitService

public interface PrintcockpitService

Method Summary

Modifier and Type	Method and Description
void	addToClipboardCollection(ObjectCollection collection, List<TypedObject> elements, boolean isCut) Adds given elements to specified collection
void	clearClipboardCollection(ObjectCollection collection) Clears given collection from existing elements
Set<String>	getAllIDs(PublicationModel pub)
List<ChapterModel>	getAllSuperChapters(ChapterModel chapter)
GridElementModel	getElement(GridModel gridModel, int gridElementID)
List<Integer>	getGridIds(GridModel gridModel)
Component	getNavigablePath(TypedObject typedObject, String attribConstant, String nodeStyleClass, Component separator, EventListener pathClickListener, boolean useButton)
ObjectCollection	getPrintcockpitClipboardCollection(UserModel user) Returns user's clipboard collection
List<ItemModel>	getRecentlyEditedPublicationElements(int count) Returns list of recently edited publication elements
PublicationComponentModel	getRegisteredElement(PublicationModel pub, String pk)
boolean	isDoublePage(TypedObject currentPageObject)
boolean	isFixedMode(TypedObject page)
void	removePlacement(PlacementModel placementToRemove) Removes placement (deletes also the page2placement relation)
void	removePublicationElementRecursively(TypedObject publicationElement) Removes given publication element and all children recursively
void	saveChapter(ChapterModel superChapter, ChapterModel chapter, int position) Saves given chapter in given super chapter at given position, if given super chapter contains this chapter, it's moved from it's old position to new position.
void	savePage(PageModel page, ChapterModel chapter, int position) Saves given page in given chapter at given position, if given chapter contains this page, it's moved from it's old position to new position, if no chapter is given then page is simply saved without assigning it to any particular chapter
void	savePlacement(PlacementModel placement, PageModel page, int position) Saves given placement in given page at given position, if given page contains this placement, it's moved from it's old position to new position, if no page is given then placement is simply saved without assigning it to any particular page

Method Detail

getGridIds

List<Integer> getGridIds(GridModel gridModel)

Parameters:

gridModel -

Returns:

list of (integers) ids of all grid elements of given grid

isFixedMode

boolean isFixedMode(TypedObject page)

Parameters:

page -

Returns:

true if page grid is in fixed mode, false otherwise. False if page has no grid assigned

getElement

GridElementModel getElement(GridModel gridModel,
                            int gridElementID)

Parameters:

gridModel -

gridElementID -

Returns:

gridElement at given gridelementID in given gridModel, null if id above elements size

savePlacement

void savePlacement(PlacementModel placement,
                   PageModel page,
                   int position)

Saves given placement in given page at given position, if given page contains this placement, it's moved from it's old position to new position, if no page is given then placement is simply saved without assigning it to any particular page

Parameters:

placement - to save

page -

position - give -1 if you wish placement to be stored at the end

savePage

void savePage(PageModel page,
              ChapterModel chapter,
              int position)

Saves given page in given chapter at given position, if given chapter contains this page, it's moved from it's old position to new position, if no chapter is given then page is simply saved without assigning it to any particular chapter

Parameters:

page -

chapter -

position - give -1 if you wish page to be stored at the end

saveChapter

void saveChapter(ChapterModel superChapter,
                 ChapterModel chapter,
                 int position)

Saves given chapter in given super chapter at given position, if given super chapter contains this chapter, it's moved from it's old position to new position. If no super chapter is given then it is saved as root chapter of this chapter publication.

Parameters:

superChapter -

chapter -

position - give -1 if you wish chapter to be stored at the end

getRegisteredElement

PublicationComponentModel getRegisteredElement(PublicationModel pub,
                                               String pk)

getAllIDs

Set<String> getAllIDs(PublicationModel pub)

removePlacement

void removePlacement(PlacementModel placementToRemove)

Removes placement (deletes also the page2placement relation)

Parameters:

placementToRemove -

getRecentlyEditedPublicationElements

List<ItemModel> getRecentlyEditedPublicationElements(int count)

Returns list of recently edited publication elements

Parameters:

count -

Returns:

list of items models

removePublicationElementRecursively

void removePublicationElementRecursively(TypedObject publicationElement)
                                  throws SecurityException

Removes given publication element and all children recursively

Parameters:

publicationElement -

Throws:

SecurityException - when user has no privileges to remove any of subelements

getNavigablePath

Component getNavigablePath(TypedObject typedObject,
                           String attribConstant,
                           String nodeStyleClass,
                           Component separator,
                           EventListener pathClickListener,
                           boolean useButton)

Parameters:

typedObject - to which path should be generated (expected: publication,chapter or page)

attribConstant - under this constant typedObject of particular node will be stored

nodeStyleClass - style class of every node (button or link)

separator - for nodes, default is label: " / "

pathClickListener - listener to handle clicks on path nodes

useButton - if true button is used as path node, link otherwise

Returns:

navigable path to given typedObject.

getAllSuperChapters

List<ChapterModel> getAllSuperChapters(ChapterModel chapter)

Parameters:

chapter - for which all super chapters are returned

Returns:

list of super chapters in order form 'the highest' to 'the lowest' (direct parent)

getPrintcockpitClipboardCollection

ObjectCollection getPrintcockpitClipboardCollection(UserModel user)

Returns user's clipboard collection

Parameters:

user -

Returns:

ObjectCollection item

addToClipboardCollection

void addToClipboardCollection(ObjectCollection collection,
                              List<TypedObject> elements,
                              boolean isCut)

Adds given elements to specified collection

Parameters:

collection - where elements will be added

elements - to be added

isCut - - if false elements will be cloned when pasted, instead of moved

clearClipboardCollection

void clearClipboardCollection(ObjectCollection collection)

Clears given collection from existing elements

Parameters:

collection -

isDoublePage

boolean isDoublePage(TypedObject currentPageObject)

Returns:

true if PageType of given page is Double, false if SINGLE