de.hybris.platform.print.jalo

Class PrintManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.print.jalo.GeneratedPrintManager

de.hybris.platform.print.jalo.PrintManager

All Implemented Interfaces:

Serializable

public class PrintManager
extends GeneratedPrintManager

This is the extension manager of the Print extension.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields inherited from class de.hybris.platform.print.jalo.GeneratedPrintManager

CATEGORY2CONTENTBLOCKRELATION_MARKMODIFIED, CATEGORY2CONTENTBLOCKRELATION_SRC_ORDERED, CATEGORY2CONTENTBLOCKRELATION_TGT_ORDERED, COMPOSEDTYPE2PLACEHOLDERTEMPLATERELATIONPLACEHOLDERTEMPLATESHANDLER, DEFAULT_INITIAL_ATTRIBUTES, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_MARKMODIFIED, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_SRC_ORDERED, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_TGT_ORDERED, PRINCIPAL2READABLEPUBLICATIONRELATION_MARKMODIFIED, PRINCIPAL2READABLEPUBLICATIONRELATION_SRC_ORDERED, PRINCIPAL2READABLEPUBLICATIONRELATION_TGT_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_MARKMODIFIED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_SRC_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_TGT_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONRELATION_MARKMODIFIED, PRINCIPAL2WRITEABLEPUBLICATIONRELATION_SRC_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONRELATION_TGT_ORDERED, PUBLICATION2MEDIA_MARKMODIFIED, PUBLICATION2MEDIA_SRC_ORDERED, PUBLICATION2MEDIA_TGT_ORDERED

Constructor Summary

Constructors

Constructor and Description
PrintManager()

Method Summary

Modifier and Type	Method and Description
void	afterItemCreation(SessionContext ctx, ComposedType type, Item createdItem, Item.ItemAttributeMap attributes) This method will be called after an item was created.
void	beforeItemCreation(SessionContext ctx, ComposedType type, Item.ItemAttributeMap attributes) This method will be called before an item is created BUT AFTER the default values of this type are assigned
CometConfiguration	createCometConfiguration(String code, String publicationController) Creates a new CometConfiguration.
void	createEssentialData(Map params, JspContext jspc)
PathPrefix	createPathPrefix(SessionContext ctx, String code, String pathWindows, String pathMac)
PathPrefix	createPathPrefix(String code, String pathWindows, String pathMac)
void	createPreviewPageJob(Page page) Deprecated. use PagePreviewTools.createPreviewPageJob(Page) instead!
void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status) Deprecated. use PagePreviewTools.createPreviewPageJob(Page, CometConstants.AutoCometJob) instead!
void	createPreviewPageJob(Page page, CometConstants.AutoCometJob status, EnumerationValue enumvalue) Deprecated. use PagePreviewTools.createPreviewPageJob(Page, CometConstants.AutoCometJob, EnumerationValue) instead!
void	createProjectData(Map params, JspContext jspc)
void	createUsersAndGroupsAndRights() Deprecated.
String	generateUniqueComponentID() Creates a unique publication component id
List<AbstractLayoutTemplate>	getAbstractLayoutTemplates(PlaceholderTemplate placeholderTemplate)
List<AbstractLayoutTemplate>	getAbstractLayoutTemplates(SessionContext ctx, PlaceholderTemplate placeholderTemplate)
Collection<LayoutTemplate>	getAllLayoutTemplates(ComposedType type)
Collection<MasterPage>	getAllMasterPages(ComposedType type)
Collection<PlaceholderTemplate>	getAllPlaceholderTemplates(ComposedType type)
List<Publication>	getAllPublications() Returns all publications in the system.
List<Publication>	getAllPublications(int start, int count) Returns all Publications in the given range.
List<TableBlock>	getAllTableTemplates() Returns all table templates in system.
AutoCometJob	getAutoCometJob(int id) Returns the AutoCometJob with the given id ot throw a AutoCometJobNotFound CometException
ClassificationUtils	getClassificationUtils()
CometConfiguration	getCometConfigurationByCode(String code) Returns the first found CometConfiguration for the given code (or null, if no CometConfiguration could be found).
CometFile	getCometFileByCode(CometConfiguration config, String code) Returns the first found CometFile for the given code in the given CometConfiguration (or null, if no CometFile could be found).
Collection<CometFile>	getCometFiles(CometConfiguration config) Returns all CometFiles of the specified CometConfiguration
String	getCreatorParameterDefault(String param) Implement this method to provide default value for the given creator parameter.
Collection	getCreatorParameterNames() Provides parameters for the system creator.
List	getCreatorParameterPossibleValues(String param) Implement this method to provide a list of all possible values for the given creator parameter.
CometConfiguration	getDefaultCometConfiguration()
PlaceholderTemplate	getDefaultPlaceholderTemplate(ComposedType type) Returns the first found PlaceholderTemplate that is assigned to the given type (or null, if no PlaceholderTemplate could be found)
ExpressionEvaluator	getExpressionEvaluator()
FormatUtils	getFormatUtils()
static PrintManager	getInstance()
List<LayoutTemplate>	getLayoutTemplates(PlaceholderTemplate placeholderTemplate)
List<LayoutTemplate>	getLayoutTemplates(SessionContext ctx, PlaceholderTemplate placeholderTemplate)
List<MasterPage>	getMasterPages(PlaceholderTemplate placeholderTemplate)
List<MasterPage>	getMasterPages(SessionContext ctx, PlaceholderTemplate placeholderTemplate)
Media	getMediaByCode(String code) Returns the first found Media with the specified code
AutoCometJob	getNextAutoCometJob()
StyleContainer	getOrCreateGlobalStyleContainer() Returns null or the existing global (singleton) StyleContainer
PathPrefix	getOrCreatePathPrefix(String code)
Page	getPage(String code)
List<Page>	getPages(Grid grid)
PathPrefix	getPathPrefixByCode(String code) Returns the PathPrefix item for the given code (or null, if an item could not be found)
Placeholder	getPlaceholderByActionId(int id)
Placeholder	getPlaceholderById(int id)
List<Placement>	getPlacements(LayoutTemplate layoutTemplate)
PriceUtils	getPriceUtils()
Publication	getPublicationByCode(String code) Returns null or the first Publication that is registered for the given code.
List<Publication>	getPublicationByConfiguration(CometConfiguration config) Returns all publications belonging to the given comet configuration.
PublicationComponent	getPublicationComponentById(String id) Returns PublicationComponent (Chapter, Page or Placement) by given ID
SessionManager	getSessionManager() Returns the SessionManager that handles Sessions of the Werk II Comet
StyleContainer	getStyleContainerByCode(String code) Returns null or the first StyleContainer that is registered for the given code.
List<Class>	getTableAxisDataProviders() Returns all table axis data provider classes.
TableBuilder	getTableBuilder()
List<Class>	getTableCellDataResolvers() Returns all table cell data resolver classes.
List<Class>	getTableSortComparators() Returns cell comparator classes.
TableRenderer	getTableToHTMLPreviewRenderer()
TableRenderer	getTableToHTMLRenderer()
TableRenderer	getTableToTaggedTextRenderer()
List<Product>	getUncategorizedProducts(CatalogVersion catalogVersion) Returns list of products from given catalog version that do not belong to any Category, but may belong to ClassificationSystem.
ValuePostProcessingService	getValuePostProcessingService()
ValuePreProcessingService	getValuePreProcessingService()
ValueUtils	getValueUtils()
VariantUtils	getVariantUtils()
void	importCSVFromResources(String csv)
void	importCSVFromResources(String csv, String encoding, char fieldseparator, char quotecharacter, boolean codeExecution)
boolean	isCreatorDisabled() This default implementation returns false.
void	loadCometConfigFromDirectory(CometConfiguration config, File rootDir) Creates CometFiles with static content for the given CometConfiguration and the given root directory of these files.
void	loadCometConfigFromZip(CometConfiguration config, URL zip) Creates CometFiles with static content for the given CometConfiguration and the given ZIP URL.
void	loadCometConfigFromZip(CometConfiguration config, ZipFile zip) Creates CometFiles with static content for the given CometConfiguration and the given ZIP file.
protected void	notifyItemRemoval(SessionContext ctx, Item item) TODO improve API doc Is called just before a item is being removed.
void	setExampleFileHandlingAttributes(PathPrefix pathPrefix)
void	setFileHandlingAttributes(Chapter chapter, String documentPath, String templateFilePath)
void	setFileHandlingAttributes(Page page, String documentPath, String templateFilePath)
void	setFileHandlingAttributes(Publication pub, String root)
void	setTableAxisDataProviders(List<Class> providers) Sets all table axis data provider classes.
void	setTableCellDataResolvers(List<Class> resolvers) Sets all table cell data resolver classes.
void	setTableSortComparators(List<Class> comparators) Sets all cell comparator classes.

Methods inherited from class de.hybris.platform.print.jalo.GeneratedPrintManager

addToContentBlocks, addToContentBlocks, addToPlaceholderTemplates, addToPlaceholderTemplates, addToPublication, addToPublication, addToReadPublication, addToReadPublication, addToReadPublicationComponent, addToReadPublicationComponent, addToWritePublication, addToWritePublication, addToWritePublicationComponent, addToWritePublicationComponent, createAction, createAction, createAttributePlaceholder, createAttributePlaceholder, createAutoCometJob, createAutoCometJob, createAxisDataHolder, createAxisDataHolder, createCellDataHolder, createCellDataHolder, createCellEntry, createCellEntry, createCellStyle, createCellStyle, createChapter, createChapter, createChapterConfiguration, createChapterConfiguration, createChapterParagraphStyle, createChapterParagraphStyle, createChaptersConfiguration, createChaptersConfiguration, createCharacterStyle, createCharacterStyle, createClassificationAttributePlaceholder, createClassificationAttributePlaceholder, createCollectionParameterValue, createCollectionParameterValue, createColumnEntry, createColumnEntry, createCometConfiguration, createCometConfiguration, createCometFile, createCometFile, createCommentGroup, createCommentGroup, createCrossreference, createCrossreference, createCrossreferenceTargetPlaceholder, createCrossreferenceTargetPlaceholder, createCustomPlaceholder, createCustomPlaceholder, createDtpComment, createDtpComment, createExpressionPlaceholder, createExpressionPlaceholder, createGrid, createGrid, createGridElement, createGridElement, createHotfolder, createHotfolder, createImageBlock, createImageBlock, createItemPlacement, createItemPlacement, createLayoutTemplate, createLayoutTemplate, createMapParameterValue, createMapParameterValue, createMasterPage, createMasterPage, createPage, createPage, createPageFormat, createPageFormat, createParagraphStyle, createParagraphStyle, createPathPrefix, createPathPrefix, createPlaceholderTemplate, createPlaceholderTemplate, createPrintJobHistoryEntry, createPrintJobHistoryEntry, createPublication, createPublication, createRowEntry, createRowEntry, createSingleParameterValue, createSingleParameterValue, createSortConfig, createSortConfig, createStyleContainer, createStyleContainer, createTableBlock, createTableBlock, createTableDataHolder, createTableDataHolder, createTablePlaceholder, createTablePlaceholder, createTableStyle, createTableStyle, createTextBlock, createTextBlock, createTOCBlock, createTOCBlock, getCommentGroup, getCommentGroup, getContentBlocks, getContentBlocks, getContentBlocksCount, getContentBlocksCount, getDefaultAttributeModes, getName, getPlaceholderTemplates, getPlaceholderTemplates, getPrincipalAssigned, getPrincipalAssigned, getPrintJobDecision, getPrintJobDecision, getPublication, getPublication, getPublicationCount, getPublicationCount, getReadPublication, getReadPublication, getReadPublicationComponent, getReadPublicationComponent, getReadPublicationComponentCount, getReadPublicationComponentCount, getReadPublicationCount, getReadPublicationCount, getWorkflow, getWorkflow, getWritePublication, getWritePublication, getWritePublicationComponent, getWritePublicationComponent, getWritePublicationComponentCount, getWritePublicationComponentCount, getWritePublicationCount, getWritePublicationCount, isReceivedByDtp, isReceivedByDtp, isReceivedByDtpAsPrimitive, isReceivedByDtpAsPrimitive, removeFromContentBlocks, removeFromContentBlocks, removeFromPlaceholderTemplates, removeFromPlaceholderTemplates, removeFromPublication, removeFromPublication, removeFromReadPublication, removeFromReadPublication, removeFromReadPublicationComponent, removeFromReadPublicationComponent, removeFromWritePublication, removeFromWritePublication, removeFromWritePublicationComponent, removeFromWritePublicationComponent, setCommentGroup, setCommentGroup, setContentBlocks, setContentBlocks, setPlaceholderTemplates, setPlaceholderTemplates, setPrincipalAssigned, setPrincipalAssigned, setPrintJobDecision, setPrintJobDecision, setPublication, setPublication, setReadPublication, setReadPublication, setReadPublicationComponent, setReadPublicationComponent, setReceivedByDtp, setReceivedByDtp, setReceivedByDtp, setReceivedByDtp, setWorkflow, setWorkflow, setWritePublication, setWritePublication, setWritePublicationComponent, setWritePublicationComponent

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeItemRemoval, createSampleData, getCreatorDescription, getCreatorName, getRemote, notifyInitializationEnd, notifyInitializationStart, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

destroy, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, unwrap, unwrap, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintManager

public PrintManager()

Method Detail

getInstance

public static PrintManager getInstance()

Returns:

instance of this manager

createEssentialData

public void createEssentialData(Map params,
                                JspContext jspc)

Overrides:

createEssentialData in class Extension

Parameters:

params - the parameters provided by user for creation of objects for the extension

jspc - the jsp context; you can use it to write progress information to the jsp page during creation

createProjectData

public void createProjectData(Map params,
                              JspContext jspc)
                       throws Exception

Overrides:

createProjectData in class Extension

Throws:

Exception

createUsersAndGroupsAndRights

@Deprecated
public void createUsersAndGroupsAndRights()

Deprecated.

loadCometConfigFromZip

public void loadCometConfigFromZip(CometConfiguration config,
                                   URL zip)

Creates CometFiles with static content for the given CometConfiguration and the given ZIP URL.

Parameters:

config - The CometConfiguration to which to add static configuration files

zip - The ZIP URL

loadCometConfigFromZip

public void loadCometConfigFromZip(CometConfiguration config,
                                   ZipFile zip)

Creates CometFiles with static content for the given CometConfiguration and the given ZIP file.

Parameters:

config - The CometConfiguration to which to add static configuration files

zip - The ZIP file

loadCometConfigFromDirectory

public void loadCometConfigFromDirectory(CometConfiguration config,
                                         File rootDir)

Creates CometFiles with static content for the given CometConfiguration and the given root directory of these files.

Parameters:

config - The CometConfiguration to which to add static configuration files

rootDir - The root directory to the static configuration files

getCometFileByCode

public CometFile getCometFileByCode(CometConfiguration config,
                                    String code)

Returns the first found CometFile for the given code in the given CometConfiguration
(or null, if no CometFile could be found).

Parameters:

config - The CometConfiguration in which to find the specified CometFile

code - The code for which to find a CometFile

Returns:

The first found CometFile for the given code

getCometFiles

public Collection<CometFile> getCometFiles(CometConfiguration config)

Returns all CometFiles of the specified CometConfiguration

Parameters:

config - The CometConfiguration from which to get all CometFiles

Returns:

Collection of CometFiles

importCSVFromResources

public void importCSVFromResources(String csv)

importCSVFromResources

public void importCSVFromResources(String csv,
                                   String encoding,
                                   char fieldseparator,
                                   char quotecharacter,
                                   boolean codeExecution)

getCreatorParameterNames

public Collection getCreatorParameterNames()

Provides parameters for the system creator.

Overrides:

getCreatorParameterNames in class Extension

Returns:

parameter names for the creator

getCreatorParameterDefault

public String getCreatorParameterDefault(String param)

Implement this method to provide default value for the given creator parameter.

Overrides:

getCreatorParameterDefault in class Extension

Parameters:

param - the name of the parameter

Returns:

default value for the given creator parameter; use null when the parameter should have no default value

getCreatorParameterPossibleValues

public List getCreatorParameterPossibleValues(String param)

Implement this method to provide a list of all possible values for the given creator parameter. If not null the list of these values will be shown to the user of system creator and no other values will be possible to set.

Overrides:

getCreatorParameterPossibleValues in class Extension

Parameters:

param - the name of the parameter

Returns:

list of all possible values for the given creator parameter; use null when this parameter should have no restriction of possible values

isCreatorDisabled

public boolean isCreatorDisabled()

This default implementation returns false.

Overrides:

isCreatorDisabled in class Extension

Returns:

false

getOrCreateGlobalStyleContainer

public StyleContainer getOrCreateGlobalStyleContainer()

Returns null or the existing global (singleton) StyleContainer

Returns:

null or the first found StyleContainer with the given code

getStyleContainerByCode

public StyleContainer getStyleContainerByCode(String code)

Returns null or the first StyleContainer that is registered for the given code.

Parameters:

code - the code of the StyleContainer to be found

Returns:

null or the first found StyleContainer with the given code

getPublicationByCode

public Publication getPublicationByCode(String code)

Returns null or the first Publication that is registered for the given code.

Parameters:

code - the code of the Publication to be found

Returns:

null or the first found Publication with the given code

getPublicationByConfiguration

public List<Publication> getPublicationByConfiguration(CometConfiguration config)

Returns all publications belonging to the given comet configuration.

Parameters:

config - comet configuration the publications belong to

Returns:

all publications belonging to the given comet configuration

getAllPublications

public List<Publication> getAllPublications(int start,
                                            int count)

Returns all Publications in the given range.

Parameters:

start - the position where the search for Publications starts (0 = first position)

count - the number of elements in this search range

Returns:

a collection of publications

getUncategorizedProducts

public List<Product> getUncategorizedProducts(CatalogVersion catalogVersion)

Returns list of products from given catalog version that do not belong to any Category, but may belong to ClassificationSystem. The list also does not include Product variants

Parameters:

catalogVersion -

Returns:

lsit of products

getAllPublications

public List<Publication> getAllPublications()

Returns all publications in the system.

Returns:

all publications in the system

getNextAutoCometJob

public AutoCometJob getNextAutoCometJob()

getAutoCometJob

public AutoCometJob getAutoCometJob(int id)

Returns the AutoCometJob with the given id ot throw a AutoCometJobNotFound CometException

Parameters:

id - the unique id of an AutoCometJob

Returns:

the found AutoCometJob

createCometConfiguration

public CometConfiguration createCometConfiguration(String code,
                                                   String publicationController)

Creates a new CometConfiguration.

Parameters:

code - The unique code of the new CometConfiguration

publicationController - The related IPublicationController for this Configuration

Returns:

A new CometConfiguration

getCometConfigurationByCode

public CometConfiguration getCometConfigurationByCode(String code)
                                               throws JaloItemNotFoundException

Returns the first found CometConfiguration for the given code
(or null, if no CometConfiguration could be found).

Parameters:

code - The code for which to find a CometConfiguration

Returns:

The first found CometConfiguration for the given code

Throws:

JaloItemNotFoundException - if no CometConfiguration with the given code exists.

getMediaByCode

public Media getMediaByCode(String code)

Returns the first found Media with the specified code

Parameters:

code - The code to find a media for

Returns:

The first found Media with the specified code

getSessionManager

public SessionManager getSessionManager()

Returns the SessionManager that handles Sessions of the Werk II Comet

Returns:

The SessionManager that handles Sessions of the Werk II Comet

getTableBuilder

public TableBuilder getTableBuilder()

getTableToHTMLRenderer

public TableRenderer getTableToHTMLRenderer()

getTableToHTMLPreviewRenderer

public TableRenderer getTableToHTMLPreviewRenderer()

getTableToTaggedTextRenderer

public TableRenderer getTableToTaggedTextRenderer()

getExpressionEvaluator

public ExpressionEvaluator getExpressionEvaluator()

getPriceUtils

public PriceUtils getPriceUtils()

getFormatUtils

public FormatUtils getFormatUtils()

getVariantUtils

public VariantUtils getVariantUtils()

getValueUtils

public ValueUtils getValueUtils()

getClassificationUtils

public ClassificationUtils getClassificationUtils()

getValuePostProcessingService

public ValuePostProcessingService getValuePostProcessingService()

getValuePreProcessingService

public ValuePreProcessingService getValuePreProcessingService()

getAbstractLayoutTemplates

public List<AbstractLayoutTemplate> getAbstractLayoutTemplates(PlaceholderTemplate placeholderTemplate)

getAbstractLayoutTemplates

public List<AbstractLayoutTemplate> getAbstractLayoutTemplates(SessionContext ctx,
                                                               PlaceholderTemplate placeholderTemplate)

getLayoutTemplates

public List<LayoutTemplate> getLayoutTemplates(PlaceholderTemplate placeholderTemplate)

getLayoutTemplates

public List<LayoutTemplate> getLayoutTemplates(SessionContext ctx,
                                               PlaceholderTemplate placeholderTemplate)

getMasterPages

public List<MasterPage> getMasterPages(PlaceholderTemplate placeholderTemplate)

getMasterPages

public List<MasterPage> getMasterPages(SessionContext ctx,
                                       PlaceholderTemplate placeholderTemplate)

getDefaultPlaceholderTemplate

public PlaceholderTemplate getDefaultPlaceholderTemplate(ComposedType type)

Returns the first found PlaceholderTemplate that is assigned to the given type
(or null, if no PlaceholderTemplate could be found)

Parameters:

type - The ComposedType for which to find a PlaceholderTemplate

Returns:

The first found PlaceholderTemplate that is assigned to the given type (or null, if no PlaceholderTemplate could be found)

getAllPlaceholderTemplates

public Collection<PlaceholderTemplate> getAllPlaceholderTemplates(ComposedType type)

getAllMasterPages

public Collection<MasterPage> getAllMasterPages(ComposedType type)

getAllLayoutTemplates

public Collection<LayoutTemplate> getAllLayoutTemplates(ComposedType type)

getPlaceholderById

public Placeholder getPlaceholderById(int id)

getPlaceholderByActionId

public Placeholder getPlaceholderByActionId(int id)

getPage

public Page getPage(String code)

getPages

public List<Page> getPages(Grid grid)

getPlacements

public List<Placement> getPlacements(LayoutTemplate layoutTemplate)

getAllTableTemplates

public List<TableBlock> getAllTableTemplates()

Returns all table templates in system.

Returns:

all table templates in system

getPublicationComponentById

public PublicationComponent getPublicationComponentById(String id)

Returns PublicationComponent (Chapter, Page or Placement) by given ID

Parameters:

id -

Returns:

PublicationComponent

generateUniqueComponentID

public String generateUniqueComponentID()

Creates a unique publication component id

Returns:

The component ID

createPathPrefix

public PathPrefix createPathPrefix(String code,
                                   String pathWindows,
                                   String pathMac)

createPathPrefix

public PathPrefix createPathPrefix(SessionContext ctx,
                                   String code,
                                   String pathWindows,
                                   String pathMac)

getOrCreatePathPrefix

public PathPrefix getOrCreatePathPrefix(String code)

setFileHandlingAttributes

public void setFileHandlingAttributes(Publication pub,
                                      String root)

setFileHandlingAttributes

public void setFileHandlingAttributes(Chapter chapter,
                                      String documentPath,
                                      String templateFilePath)

setFileHandlingAttributes

public void setFileHandlingAttributes(Page page,
                                      String documentPath,
                                      String templateFilePath)

setExampleFileHandlingAttributes

public void setExampleFileHandlingAttributes(PathPrefix pathPrefix)

getTableAxisDataProviders

public List<Class> getTableAxisDataProviders()

Returns all table axis data provider classes.

Returns:

all table axis data provider classes

See Also:

AxisDataProvider

setTableAxisDataProviders

public void setTableAxisDataProviders(List<Class> providers)

Sets all table axis data provider classes. Normally injected by spring.

Parameters:

providers - provider classes

See Also:

AxisDataProvider

getTableCellDataResolvers

public List<Class> getTableCellDataResolvers()

Returns all table cell data resolver classes.

Returns:

all table cell data resolver classes

See Also:

CellDataResolver

setTableCellDataResolvers

public void setTableCellDataResolvers(List<Class> resolvers)

Sets all table cell data resolver classes. Normally injected by spring.

Parameters:

resolvers - resolver classes

See Also:

CellDataResolver

getTableSortComparators

public List<Class> getTableSortComparators()

Returns cell comparator classes.

Returns:

all cell comparator classes

See Also:

CellValueComparator

setTableSortComparators

public void setTableSortComparators(List<Class> comparators)

Sets all cell comparator classes. Normally injected by spring.

Parameters:

comparators - comparator classes

See Also:

CellValueComparator

getDefaultCometConfiguration

public CometConfiguration getDefaultCometConfiguration()

getPathPrefixByCode

public PathPrefix getPathPrefixByCode(String code)

Returns the PathPrefix item for the given code (or null, if an item could not be found)

Parameters:

code - The code for which to find a PathPrefix item.
This could be either the code for itselfe or the complete variable like e.g. {pathPrefix:code}

Returns:

A PathPrefix item (or null, if no item could be found for the given code)

beforeItemCreation

public void beforeItemCreation(SessionContext ctx,
                               ComposedType type,
                               Item.ItemAttributeMap attributes)
                        throws JaloBusinessException

Description copied from class: Manager

This method will be called before an item is created BUT AFTER the default values of this type are assigned

Overrides:

beforeItemCreation in class Manager

Parameters:

ctx - the currency session context

type - the type of the item which will be created

attributes - the attribute values to be used for creation

Throws:

JaloBusinessException

See Also:

This method does nothing and may be overridden.

CAUTION: This method will be called inside a transaction !!!

afterItemCreation

public void afterItemCreation(SessionContext ctx,
                              ComposedType type,
                              Item createdItem,
                              Item.ItemAttributeMap attributes)
                       throws JaloBusinessException

Description copied from class: Manager

This method will be called after an item was created.

Overrides:

afterItemCreation in class Manager

Parameters:

ctx - the currency session context

type - the type of the item which will be created

createdItem - the created item

Throws:

JaloBusinessException

See Also:

This method does nothing and may be overridden.

CAUTION: This method will be called inside a transaction !!!

createPreviewPageJob

@Deprecated
public void createPreviewPageJob(Page page)

Deprecated. use PagePreviewTools.createPreviewPageJob(Page) instead!

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

createPreviewPageJob

@Deprecated
public void createPreviewPageJob(Page page,
                                             CometConstants.AutoCometJob status,
                                             EnumerationValue enumvalue)

Deprecated. use PagePreviewTools.createPreviewPageJob(Page, CometConstants.AutoCometJob, EnumerationValue) instead!

Creates an AutoCometJob that creates previews for pages

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

enumvalue - These Job will be, depending of the enum, deleted

createPreviewPageJob

@Deprecated
public void createPreviewPageJob(Page page,
                                             CometConstants.AutoCometJob status)

Deprecated. use PagePreviewTools.createPreviewPageJob(Page, CometConstants.AutoCometJob) instead!

Creates an AutoCometJob that creates previews for pages. The created Job will not be deleted after fished.

Parameters:

page - The Page for which to create the previews

status - The AutoCometJob's initial status

notifyItemRemoval

protected void notifyItemRemoval(SessionContext ctx,
                                 Item item)

Description copied from class: Manager

TODO improve API doc Is called just before a item is being removed. No exception should be thrown here. Use Manager.checkBeforeItemRemoval(SessionContext, Item) instead.

This method does nothing and may be overridden.

Overrides:

notifyItemRemoval in class Extension

Parameters:

ctx - the currency session context

item - the item which is going to be removed