Package 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.storage.HistoryProvider

HistoryProvider.RevisionProvider

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

IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType

Field Summary

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

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

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

CHANGED, NEVER_RELEASED, RELEASED

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

BLOCKED, MODIFIED, UNMODIFIED

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

OPEN_ENDED

Method Summary

Modifier and Type	Method	Description
void	excludeFromOutput(Language language)	A language cannot be excluded in the output of the generation, so every call will throw an exception.
ContentMultiPageParams	getMultiPageParams(@NotNull Language language)	Delivers a ContentMultiPageParams where ContentMultiPageParams.getData() delivers a list with one entry.
String	getTableName()	Returns the name of the entity type this content section belongs to.
@NotNull TableTemplate	getTableTemplate()	Returns the table template this content section belongs to.
@NotNull 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)	Returns true as content2 sections are categorical included in the output.
void	setLifespan(long from, long to)	Content sections support no lifespan - will result in an UnsupportedOperationException.
void	setTemplate(@NotNull TableTemplate template)	Throws an UnsupportedOperationException as changing the template is not supported.

Methods inherited from interface java.lang.Comparable

compareTo

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

clearCachedData, getData, getFormData, setData, setFormData

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

asRevisionProvider, getHistory, getHistory

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

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

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.pagestore.Section

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

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

appendChild, appendChildBefore, delete, exportStoreElement, getChildCount, getChildIndex, getChildren, getChildren, getChildren, getChildren, getCreateWorkflowPermission, getDefinedPrincipalPermissions, getEditor, getElementType, getFirstChild, getIncomingReferences, getInheritedPrincipalPermissions, getLastChanged, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferenceName, getReferences, getStore, getTreePermission, getWorkflowPermission, getWorkflowPermissions, getWriteLock, hasIncomingReferences, 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, setPermission, setPermission, setPermission, setWorkflowPermission, setWorkflowPermissions, setWriteLock, toXml, toXml, toXml

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Method Details

getTableTemplate

@NotNull
@NotNull TableTemplate getTableTemplate()
                                 throws ReferenceNotFoundException

Returns the table template this content section belongs to.

Returns:

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

Throws:

ReferenceNotFoundException - if table template is missing

Since:

3.0

getTableName

String getTableName()

Returns the name of the entity type this content section belongs to.

Returns:

java.lang.String

Since:

3.0

getTemplate

@NotNull
@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>

Returns:

the template of type <T>

Throws:

ReferenceNotFoundException - if template is missing

Since:

3.0

setTemplate

void setTemplate(@NotNull
 @NotNull TableTemplate template)

Throws an UnsupportedOperationException as changing the template is not supported.

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)

Returns true as content2 sections are categorical included in the output.

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

getMultiPageParams

ContentMultiPageParams getMultiPageParams(@NotNull
 @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