Package de.espirit.firstspirit.access.store.templatestore

Interface TableTemplate

All Superinterfaces:

ChannelSourceProvider, Comparable<StoreElement>, DatasetProvider, GomSourceProvider, HistoryProvider, IDProvider, MasterTemplate, PackagePoolItem, PreviewImageProvider, Referenceable, RulesetContainer, RulesetContainer, SectionTemplate, SnippetContainer, StoreElement, Template, TemplateContentProvider, TemplateStoreElement, Workflowable

public interface TableTemplate
extends SectionTemplate, DatasetProvider

Interface for templates defining GUI for content store.

Since:

3.0.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TableTemplate.Mapping	Type providing information on a mapping of a field to a column.

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

Modifier and Type	Field	Description
static final TableTemplate.Mapping[]	EMPTY_MAPPINGS	Empty mappings.
static final IDProvider.UidType	UID_TYPE	The template's UID type.

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.templatestore.Template

CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE

Method Summary

Modifier and Type	Method	Description
@NotNull EntityType	getEntityType()	Provides the entity type (the db table) this template bases upon.
@NotNull TableTemplate.Mapping[]	getMappings()	Shortcut for getMappings(false)
@NotNull TableTemplate.Mapping[]	getMappings(boolean release)	Provides an array of TableTemplate.Mappings, whose entries are safe to change with no feedback to this template.
TableTemplate.Mapping[]	getMappings(TableTemplate.Mapping[] oldMappings, GomEditorProvider gomProvider)	Convenience method for getMappings(oldMappings, gomProvider, false).
TableTemplate.Mapping[]	getMappings(TableTemplate.Mapping[] oldMappings, GomEditorProvider gomProvider, boolean release)	Get the TableTemplate.Mappings for this template based on the given GOM provider.
String	getRefKey()	Provides a reference key of this template.
int	getRowHeight()	Height of displayed rows (in line numbers).
@NotNull Schema	getSchema()	Gets the schema.
long	getTemplateId()	Get the project local id of this template.
@NotNull IDProvider.UidType	getUidType()	Returns UID_TYPE.
boolean	isCopyAllowed()	Returns true if the user is allowed to copy entities.
void	setCopyAllowed(boolean value)	Enable or disable the possibility to copy entities.
void	setMappings(TableTemplate.Mapping[] mappings)	Set the TableTemplate.Mappings for this template.
void	setRowHeight(int value)	Set the height of the displayed rows to the given value.

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.ChannelSourceProvider

getChannelSource, setChannelSource

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider

createDataset, getDataset, getDataset

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider

getDefaults, getFormDefaults, getGomProvider, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource

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, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isInReleaseStore, isReachableInReleaseStore, isReleased, isReleased, isReleaseSupported, moveChild, moveChild, release, release, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.MasterTemplate

getExtensions, getPreviewPageRef, getTemplateExtension, hasMultiPageParamsProviderEditor, hasPreviewPageRef, setPreviewPageRef

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.templatestore.PreviewImageProvider

getPreviewImage, setPreviewImage

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

getReferenceName

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.RulesetContainer

getRulesetDefinition, setRulesetDefinition

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.SnippetContainer

getSnippet, setSnippet

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, getName, getNextSibling, getOutgoingReferences, getPermission, getPermission, getPermission, getPreviousSibling, getProject, getReferences, 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.store.templatestore.Template

getComment, getType, isHidden, setComment, setHidden

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.TemplateContentProvider

getTemplateDocument

Methods inherited from interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreElement

getSubRootInStore

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

getColor, getTask, hasTask, removeTask, setColor, setTask

Field Details

UID_TYPE

static final IDProvider.UidType UID_TYPE

The template's UID type.

Since:

4.0.20

EMPTY_MAPPINGS

static final TableTemplate.Mapping[] EMPTY_MAPPINGS

Empty mappings.

Since:

3.0

Method Details

getEntityType

@NotNull
@NotNull EntityType getEntityType()
                           throws EntityTypeNotFoundException

Provides the entity type (the db table) this template bases upon.

Specified by:

getEntityType in interface DatasetProvider

Returns:

The entity type.

Throws:

EntityTypeNotFoundException - when a referenced entity type (database table) does not exist.

Since:

4.0.13

getRefKey

String getRefKey()

Provides a reference key of this template.

Returns:

The reference key.

Since:

3.0

getSchema

@NotNull
@NotNull Schema getSchema()

Gets the schema.

Specified by:

getSchema in interface DatasetProvider

Returns:

Provides the schema.

Since:

3.0

getMappings

@NotNull
@NotNull TableTemplate.Mapping[] getMappings()

Shortcut for getMappings(false)

Since:

3.0

getMappings

@NotNull
@NotNull TableTemplate.Mapping[] getMappings(boolean release)

Provides an array of TableTemplate.Mappings, whose entries are safe to change with no feedback to this template.

Since:

3.0.127

getMappings

TableTemplate.Mapping[] getMappings(TableTemplate.Mapping[] oldMappings,
 GomEditorProvider gomProvider)
                             throws IOException

Convenience method for getMappings(oldMappings, gomProvider, false).

Throws:

IOException

Since:

4.0

getMappings

TableTemplate.Mapping[] getMappings(TableTemplate.Mapping[] oldMappings,
 GomEditorProvider gomProvider,
 boolean release)
                             throws IOException

Get the TableTemplate.Mappings for this template based on the given GOM provider. The provided entries are safe to change with no feedback to this template.

Parameters:

oldMappings - The old mappings.

gomProvider - The GOM provider object.

release - If true, returns on release state.

Returns:

The mappings for this template.

Throws:

IOException - If the mappings could not be read.

Since:

4.0

setMappings

void setMappings(TableTemplate.Mapping[] mappings)

Set the TableTemplate.Mappings for this template.

Since:

3.0

getUidType

@NotNull
@NotNull IDProvider.UidType getUidType()

Returns UID_TYPE.

Specified by:

getUidType in interface IDProvider

Returns:

UID_TYPE

Since:

4.0.20

See Also:

• IDProvider.hasUid()

getRowHeight

int getRowHeight()

Height of displayed rows (in line numbers). Default value is 1.

Returns:

row height in number of lines

Since:

4.1.27

setRowHeight

void setRowHeight(int value)

Set the height of the displayed rows to the given value.

Parameters:

value - The height that should be set for the displayed rows.

Throws:

IllegalArgumentException - if provided value is below 1

Since:

4.1.27

See Also:

• getRowHeight()

isCopyAllowed

boolean isCopyAllowed()

Returns true if the user is allowed to copy entities.

Since:

4.1.18

setCopyAllowed

void setCopyAllowed(boolean value)

Enable or disable the possibility to copy entities.

Parameters:

value - new state

Since:

4.1.18

See Also:

• isCopyAllowed()

getTemplateId

long getTemplateId()

Get the project local id of this template.

Specified by:

getTemplateId in interface MasterTemplate

Returns:

Project local id of this template.

Since:

3.0