de.espirit.firstspirit.access.store.pagestore
Interface Content2Section

All Superinterfaces:

Comparable<StoreElement>, DataProvider, HistoryProvider, IDProvider, MultiPageParamsProvider, PackagePoolItem, Section<TableTemplate>, StoreElement, TemplateProvider<TableTemplate>, Workflowable

public interface Content2Section
extends Section<TableTemplate>, MultiPageParamsProvider

This is a section which renders new content.

Since:

3.0

See Also:

TableTemplate, Content2Params

Nested Class Summary

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Nested classes/interfaces inherited from interface de.espirit.firstspirit.access.store.IDProvider

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Nested classes/interfaces inherited from interface de.espirit.firstspirit.storage.HistoryProvider

HistoryProvider.RevisionProvider

Field Summary

Fields inherited from interface de.espirit.firstspirit.access.store.pagestore.Section

OPEN_ENDED

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.access.store.StoreElement

RELEASE_REQUESTED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.access.store.StoreElement

RELEASE_REQUESTED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE

Fields inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

BLOCKED, MODIFIED, UNMODIFIED

Fields inherited from interface de.espirit.firstspirit.access.store.IDProvider

CHANGED, NEVER_RELEASED, RELEASED

Fields inherited from interface de.espirit.firstspirit.access.store.StoreElement

RELEASE_REQUESTED

Fields inherited from interface de.espirit.firstspirit.storage.HistoryProvider

ALL_REVISIONS, EVER_SINCE

Method Summary

void	excludeFromOutput(Language language) A language cannot be excluded in the output of the generation, so every call will throw an exception.
List<Entity>	getContent() Deprecated. since 4.0.52 - This method delivers all entities of the rendered entity type, use MultiPageParamsProvider.getMultiPageParams(de.espirit.firstspirit.access.Language) which delivers one entity.
ContentMultiPageParams	getMultiPageParams(Language language) Delivers a ContentMultiPageParams where ContentMultiPageParams.getData() delivers a list with one entry.
TableTemplate	getSectionTemplate() Deprecated. since 4.1.10 - use Content2Section.getTemplate()
String	getTableName()
TableTemplate	getTableTemplate()
TableTemplate	getTemplate() Returns the template of this element.
void	includeInOutput(Language language) Has no effect, no language can be excluded in the output of the generation.
boolean	isInOutputIncluded(Language language) Checks if this section is included in the output for the given language.
void	setLifespan(long from, long to) Content sections support no lifespan - will result in an UnsupportedOperationException.
void	setSectionTemplate(Template sectionTemplate) Set the Section-Template for the current section
void	setTemplate(TableTemplate template) Set the template for this section.

Methods inherited from interface de.espirit.firstspirit.access.store.pagestore.Section

getLifespan, getName, getReference, isInLifespan, isInLifespan, isReference, removeLifespan, setName

Methods inherited from interface de.espirit.firstspirit.access.store.pagestore.DataProvider

clearCachedData, getData, getFormData, setData, setFormData

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Methods inherited from interface de.espirit.firstspirit.access.store.PackagePoolItem

addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState

Methods inherited from interface de.espirit.firstspirit.access.store.IDProvider

clone, contrastWith, getDisplayName, getId, getID, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, getUidType, hasMeta, hasUid, isInReleaseStore, isReleaseSupported, moveChild, moveChild, release, release, revert, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.StoreElement

appendChild, appendChildBefore, delete, exportStoreElement, getAllChilds, getAllFilteredChilds, getChildByName, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getChilds, getChilds, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getDisplayName, getEditor, getElementType, getFilteredChilds, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getLock, getMetaXml, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getProject, getReferenceName, getReferences, getSortedChilds, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, hasMetaXml, hasPermissions, importStoreElement, importStoreElements, inheritWorkflowPermission, isDeleted, isExportSupported, isFolder, isImportSupported, isLocked, isLockedOnServer, isLockSupported, isPermissionSupported, isWorkflowAllowed, isWorkflowSupported, refresh, removeAllWorkflowPermissions, removeChild, removePermission, removePermission, removePermission, removeWorkflowPermission, replaceChild, save, save, save, setInheritWorkflowPermission, setLock, setLock, setMetaXml, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml, unrelease, unrelease, update

Methods inherited from interface de.espirit.firstspirit.access.Workflowable

getColor, getTask, hasTask, removeTask, setColor, setTask

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.storage.HistoryProvider

asRevisionProvider, getHistory, getHistory

Method Detail

getTableTemplate

@NotNull
TableTemplate getTableTemplate()
                               throws ReferenceNotFoundException

Returns:

de.espirit.firstspirit.access.store.templatestore.TableTemplate

Throws:

ReferenceNotFoundException - if table template is missing

Since:

3.0

getTableName

String getTableName()

Returns:

java.lang.String

Since:

3.0

getTemplate

@NotNull
TableTemplate getTemplate()
                          throws ReferenceNotFoundException

Returns the template of this element.

Specified by:

getTemplate in interface Section<TableTemplate>

Specified by:

getTemplate in interface TemplateProvider<TableTemplate>

Throws:

ReferenceNotFoundException - if template is missing

Since:

3.0

getSectionTemplate

@Deprecated
@NotNull
TableTemplate getSectionTemplate()
                                 throws ReferenceNotFoundException

Deprecated. since 4.1.10 - use Content2Section.getTemplate()

Specified by:

getSectionTemplate in interface Section<TableTemplate>

Throws:

ReferenceNotFoundException

Since:

3.0

setSectionTemplate

void setSectionTemplate(@NotNull
                        Template sectionTemplate)
                        throws UnsupportedOperationException

Description copied from interface: Section

Set the Section-Template for the current section

Specified by:

setSectionTemplate in interface Section<TableTemplate>

Parameters:

sectionTemplate - new Section-Template as object

Throws:

UnsupportedOperationException - always

Since:

3.0

setTemplate

void setTemplate(@NotNull
                 TableTemplate template)

Description copied from interface: Section

Set the template for this section.

Specified by:

setTemplate in interface Section<TableTemplate>

Parameters:

template - new template

Throws:

UnsupportedOperationException - always

Since:

4.1.25

setLifespan

void setLifespan(long from,
                 long to)
                 throws UnsupportedOperationException

Content sections support no lifespan - will result in an UnsupportedOperationException.

Specified by:

setLifespan in interface Section<TableTemplate>

Parameters:

from - start date for lifespan (in milliseconds since 1.1.1970 0:00 UTC)

to - end date for lifespan (in milliseconds since 1.1.1970 0:00 UTC) or -1L for no restriction

Throws:

UnsupportedOperationException - always

Since:

3.0

See Also:

Section.getLifespan(), Section.removeLifespan(), Section.isInLifespan()

includeInOutput

void includeInOutput(Language language)

Has no effect, no language can be excluded in the output of the generation.

Specified by:

includeInOutput in interface Section<TableTemplate>

Parameters:

language - the language to include this section for

Since:

3.0

excludeFromOutput

void excludeFromOutput(Language language)
                       throws UnsupportedOperationException

A language cannot be excluded in the output of the generation, so every call will throw an exception.

Specified by:

excludeFromOutput in interface Section<TableTemplate>

Parameters:

language - the language to exclude for this section

Throws:

UnsupportedOperationException - always

Since:

3.0

isInOutputIncluded

boolean isInOutputIncluded(Language language)

Description copied from interface: Section

Checks if this section is included in the output for the given language.

Specified by:

isInOutputIncluded in interface Section<TableTemplate>

Parameters:

language - the language to check this section for

Returns:

true regardless of the parameter

Since:

3.0

getContent

@Deprecated
List<Entity> getContent()
                        throws IOException

Deprecated. since 4.0.52 - This method delivers all entities of the rendered entity type, use MultiPageParamsProvider.getMultiPageParams(de.espirit.firstspirit.access.Language) which delivers one entity.

Return a list containing Entity.

Throws:

IOException

Since:

4.0

getMultiPageParams

ContentMultiPageParams getMultiPageParams(@NotNull
                                          Language language)

Delivers a ContentMultiPageParams where ContentMultiPageParams.getData() delivers a list with one entry.

Specified by:

getMultiPageParams in interface MultiPageParamsProvider

Parameters:

language - this parameter is ignored

Since:

4.0