de.hybris.platform.print.jalo

Class Chapter

java.lang.Object

de.hybris.platform.util.BridgeAbstraction

de.hybris.platform.jalo.Item

de.hybris.platform.jalo.ExtensibleItem

de.hybris.platform.jalo.c2l.LocalizableItem

de.hybris.platform.jalo.GenericItem

de.hybris.platform.print.jalo.GeneratedPublicationComponent

de.hybris.platform.print.jalo.PublicationComponent

de.hybris.platform.print.jalo.GeneratedChapter

de.hybris.platform.print.jalo.Chapter

All Implemented Interfaces:

Serializable, Comparable

public class Chapter
extends GeneratedChapter

See Also:

Serialized Form

Nested Class Summary

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

GenericItem.GenericItemImpl

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

LocalizableItem.LocalizableItemImpl

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

ExtensibleItem.ExtensibleItemImpl

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

Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException

Field Summary

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

CHAPTERCONFIGURATION, CODE, COMMENT, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, DOCUMENTTEMPLATE, FILENAME, FILEPATH, FOOTER, HEADER, PAGES, PAGESHANDLER, PICTURE, PLANNEDREVENUE, PREVIEWIMAGES, PREVIEWPDFS, PREVIEWS, PREVIEWSHANDLER, REACHEDREVENUE, STATUS, SUBCHAPTERS, SUBCHAPTERSHANDLER, SUBTITLE, SUBTITLE2, SUPERCHAPTER, SUPERCHAPTERHANDLER, SUPERCHAPTERPOS, TITLE

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

ID, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_MARKMODIFIED, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_SRC_ORDERED, PRINCIPAL2READABLEPUBLICATIONCOMPONENTRELATION_TGT_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_MARKMODIFIED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_SRC_ORDERED, PRINCIPAL2WRITEABLEPUBLICATIONCOMPONENTRELATION_TGT_ORDERED, PUBLICATION, PUBLICATIONHANDLER, PUBLICATIONPOS, READPRINCIPALS, WRITEPRINCIPALS

Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

LANGUAGE_FALLBACK_ENABLED

Fields inherited from class de.hybris.platform.jalo.Item

_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE

Fields inherited from class de.hybris.platform.util.BridgeAbstraction

impl, tenant

Constructor Summary

Constructors

Constructor and Description
Chapter()

Method Summary

Modifier and Type	Method and Description
protected ChapterConfiguration	getChapterConfigurationByLevel(Collection<ChapterConfiguration> chapterConfigurations, int level) Returns the ChapterConfiguration that corresponds to the given category level (or null, of an applicable ChapterConfiguration could not be found)
String	getDocumentTemplate(SessionContext ctx) Generated method - Getter of the Chapter.documentTemplate attribute.
String	getFileName(SessionContext ctx) Generated method - Getter of the Chapter.fileName attribute.
String	getFilePath(SessionContext ctx) Generated method - Getter of the Chapter.filePath attribute.
EnumerationValue	getFlowControl() Returns the FlowControl setting for this Chapter (or null, if no FlowControl type was set)
int	getFlowControlAsInt() Returns the FlowControl setting for this ContentCategory as int
protected int	getLevel() Returns the chapter level of this chapter
Double	getPlannedRevenue(SessionContext ctx) Generated method - Getter of the Chapter.plannedRevenue attribute.
Collection<CometFile>	getPreviewImages(SessionContext ctx) Generated method - Getter of the Chapter.previewImages attribute.
Collection<CometFile>	getPreviewPdfs(SessionContext ctx) Generated method - Getter of the Chapter.previewPdfs attribute.
Double	getReachedRevenue(SessionContext ctx) Generated method - Getter of the Chapter.reachedRevenue attribute.
void	setDocumentTemplate(SessionContext ctx, String value) Generated method - Setter of the Chapter.documentTemplate attribute.
void	setFileName(SessionContext ctx, String value) Generated method - Setter of the Chapter.fileName attribute.
void	setFilePath(SessionContext ctx, String value) Generated method - Setter of the Chapter.filePath attribute.
void	setSuperChapter(SessionContext ctx, Chapter chapter) Generated method - Setter of the Chapter.superChapter attribute.
boolean	showChapter() Returns TRUE if this Chapter shall be displayed/used in a document

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

addToPages, addToPages, addToPreviews, addToPreviews, addToSubChapters, addToSubChapters, createItem, getAllDescription, getAllDescription, getAllFooter, getAllFooter, getAllHeader, getAllHeader, getAllSubTitle, getAllSubTitle, getAllSubTitle2, getAllSubTitle2, getAllTitle, getAllTitle, getChapterConfiguration, getChapterConfiguration, getCode, getCode, getComment, getComment, getDefaultAttributeModes, getDescription, getDescription, getDocumentTemplate, getFileName, getFilePath, getFooter, getFooter, getHeader, getHeader, getPages, getPages, getPicture, getPicture, getPlannedRevenue, getPlannedRevenueAsPrimitive, getPlannedRevenueAsPrimitive, getPreviewImages, getPreviewPdfs, getPreviews, getPreviews, getReachedRevenue, getReachedRevenueAsPrimitive, getReachedRevenueAsPrimitive, getStatus, getStatus, getSubChapters, getSubChapters, getSubTitle, getSubTitle, getSubTitle2, getSubTitle2, getSuperChapter, getSuperChapter, getTitle, getTitle, removeFromPages, removeFromPages, removeFromPreviews, removeFromPreviews, removeFromSubChapters, removeFromSubChapters, setAllDescription, setAllDescription, setAllFooter, setAllFooter, setAllHeader, setAllHeader, setAllSubTitle, setAllSubTitle, setAllSubTitle2, setAllSubTitle2, setAllTitle, setAllTitle, setChapterConfiguration, setChapterConfiguration, setCode, setCode, setComment, setComment, setDescription, setDescription, setDocumentTemplate, setFileName, setFilePath, setFooter, setFooter, setHeader, setHeader, setPages, setPages, setPicture, setPicture, setPreviews, setPreviews, setStatus, setStatus, setSubChapters, setSubChapters, setSubTitle, setSubTitle, setSubTitle2, setSubTitle2, setSuperChapter, setTitle, setTitle

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

isReadable, isWritable

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

addToReadPrincipals, addToReadPrincipals, addToWritePrincipals, addToWritePrincipals, getId, getId, getPublication, getPublication, getReadPrincipals, getReadPrincipals, getReadPrincipalsCount, getReadPrincipalsCount, getWritePrincipals, getWritePrincipals, getWritePrincipalsCount, getWritePrincipalsCount, removeFromReadPrincipals, removeFromReadPrincipals, removeFromWritePrincipals, removeFromWritePrincipals, setId, setId, setPublication, setPublication, setReadPrincipals, setReadPrincipals, setWritePrincipals, setWritePrincipals

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

getInitialProperties, getNonInitialAttributes

Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem

getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty

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

createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty

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

addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, checkRemovable, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, readResolve, refreshRemote, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setNonInitialAttributes, setOwner, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace

Methods inherited from class de.hybris.platform.util.BridgeAbstraction

getImplementation, setTenant

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Chapter

public Chapter()

Method Detail

getFlowControl

public EnumerationValue getFlowControl()
                                throws JaloItemNotFoundException

Returns the FlowControl setting for this Chapter (or null, if no FlowControl type was set)

Returns:

The FlowControl setting for this Chapter (or null, if no FlowControl type was set)

Throws:

JaloItemNotFoundException - If a Publication could not be found

getFlowControlAsInt

public int getFlowControlAsInt()

Returns the FlowControl setting for this ContentCategory as int

Returns:

The FlowControl setting for this ContentCategory as int

showChapter

public boolean showChapter()
                    throws JaloItemNotFoundException

Returns TRUE if this Chapter shall be displayed/used in a document

Returns:

TRUE if this Chapter shall be displayed/used in a document

Throws:

JaloItemNotFoundException - If a related Publication could not be found

getLevel

protected int getLevel()

Returns the chapter level of this chapter

Returns:

The chapter level of this chapter

getChapterConfigurationByLevel

protected ChapterConfiguration getChapterConfigurationByLevel(Collection<ChapterConfiguration> chapterConfigurations,
                                                              int level)

Returns the ChapterConfiguration that corresponds to the given category level
(or null, of an applicable ChapterConfiguration could not be found)

Parameters:

chapterConfigurations -

level -

Returns:

The ChapterConfiguration that corresponds to the given category level (or null)

getDocumentTemplate

public String getDocumentTemplate(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.documentTemplate attribute.

Overrides:

getDocumentTemplate in class GeneratedChapter

Returns:

the documentTemplate

getFileName

public String getFileName(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.fileName attribute.

Overrides:

getFileName in class GeneratedChapter

Returns:

the fileName

getFilePath

public String getFilePath(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.filePath attribute.

Overrides:

getFilePath in class GeneratedChapter

Returns:

the filePath

setDocumentTemplate

public void setDocumentTemplate(SessionContext ctx,
                                String value)

Description copied from class: GeneratedChapter

Generated method - Setter of the Chapter.documentTemplate attribute.

Overrides:

setDocumentTemplate in class GeneratedChapter

value - the documentTemplate

setFileName

public void setFileName(SessionContext ctx,
                        String value)

Description copied from class: GeneratedChapter

Generated method - Setter of the Chapter.fileName attribute.

Overrides:

setFileName in class GeneratedChapter

value - the fileName

setFilePath

public void setFilePath(SessionContext ctx,
                        String value)

Description copied from class: GeneratedChapter

Generated method - Setter of the Chapter.filePath attribute.

Overrides:

setFilePath in class GeneratedChapter

value - the filePath

setSuperChapter

public void setSuperChapter(SessionContext ctx,
                            Chapter chapter)

Description copied from class: GeneratedChapter

Generated method - Setter of the Chapter.superChapter attribute.

Overrides:

setSuperChapter in class GeneratedChapter

chapter - the superChapter

getPlannedRevenue

public Double getPlannedRevenue(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.plannedRevenue attribute.

Specified by:

getPlannedRevenue in class GeneratedChapter

Returns:

the plannedRevenue

getReachedRevenue

public Double getReachedRevenue(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.reachedRevenue attribute.

Specified by:

getReachedRevenue in class GeneratedChapter

Returns:

the reachedRevenue

getPreviewImages

public Collection<CometFile> getPreviewImages(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.previewImages attribute.

Specified by:

getPreviewImages in class GeneratedChapter

Returns:

the previewImages

getPreviewPdfs

public Collection<CometFile> getPreviewPdfs(SessionContext ctx)

Description copied from class: GeneratedChapter

Generated method - Getter of the Chapter.previewPdfs attribute.

Specified by:

getPreviewPdfs in class GeneratedChapter

Returns:

the previewPdfs