public interface TableTemplate extends SectionTemplate, DatasetProvider
Modifier and Type | Interface and Description |
---|---|
static interface |
TableTemplate.Mapping
Type providing information on a mapping of a field to a column.
|
IDProvider.DependentReleaseType, IDProvider.RevertType, IDProvider.UidType
HistoryProvider.RevisionProvider
Modifier and Type | Field and Description |
---|---|
static TableTemplate.Mapping[] |
EMPTY_MAPPINGS
Empty mappings.
|
static IDProvider.UidType |
UID_TYPE
The template's UID type.
|
CONTENT_TEMPLATE, LINK_TEMPLATE, PAGE_TEMPLATE, SECTION_TEMPLATE
CHANGED, NEVER_RELEASED, RELEASED
ALL_REVISIONS, EVER_SINCE, UNTIL_NOW
BLOCKED, MODIFIED, UNMODIFIED
Modifier and Type | Method and Description |
---|---|
EntityType |
getEntityType()
Provides the entity type (the db table) this template bases upon.
|
TableTemplate.Mapping[] |
getMappings()
Shortcut for
getMappings(false) |
TableTemplate.Mapping[] |
getMappings(boolean release)
Provides an array of
TableTemplate.Mapping s, 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.Mapping s 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).
|
Schema |
getSchema()
Gets the schema.
|
long |
getTemplateId()
Get the project local id of this template.
|
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.Mapping s for this template. |
void |
setRowHeight(int value)
Set the height of the displayed rows to the given value.
|
getExtensions, getPreviewPageRef, getTemplateExtension, hasMultiPageParamsProviderEditor, hasPreviewPageRef, setPreviewPageRef
getComment, getType, isHidden, setComment, setHidden
getReferenceName
getDefaults, getFormDefaults, getGomProvider, getGomSource, setDefaults, setFormDefaults, setGomProvider, setGomSource
getTemplateDocument
getChannelSource, setChannelSource
contrastWith, getDisplayName, getId, getInRevision, getLanguageInfo, getLongID, getMeta, getMetaFormData, getParent, getReleasedBy, getReleaseRevision, getReleaseStatus, getRevision, getUid, hasMeta, hasUid, isInReleaseStore, isReleased, isReleaseSupported, moveChild, moveChild, release, release, revert, setDisplayName, setMeta, setMetaFormData, setUid
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, 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
getColor, getTask, hasTask, removeTask, setColor, setTask
compareTo
asRevisionProvider, getHistory, getHistory
getRulesetDefinition, setRulesetDefinition
getSnippet, setSnippet
addToPackage, getChangeState, getPackage, getPackageName, isAddable, isChangeable, isPackageItem, isSubscribedItem, removeFromPackage, setChangeState
getSubRootInStore
getPreviewImage, setPreviewImage
createDataset, getDataset, getDataset
static final IDProvider.UidType UID_TYPE
static final TableTemplate.Mapping[] EMPTY_MAPPINGS
@NotNull EntityType getEntityType() throws de.espirit.firstspirit.access.database.EntityTypeNotFoundException
getEntityType
in interface DatasetProvider
de.espirit.firstspirit.access.database.EntityTypeNotFoundException
- when a referenced entity type (database table) does not exist.String getRefKey()
@NotNull Schema getSchema()
getSchema
in interface DatasetProvider
@NotNull TableTemplate.Mapping[] getMappings()
getMappings(false)
@NotNull TableTemplate.Mapping[] getMappings(boolean release)
TableTemplate.Mapping
s, whose entries are safe to change with no feedback to this template.TableTemplate.Mapping[] getMappings(TableTemplate.Mapping[] oldMappings, GomEditorProvider gomProvider) throws IOException
getMappings(oldMappings, gomProvider, false)
.IOException
TableTemplate.Mapping[] getMappings(TableTemplate.Mapping[] oldMappings, GomEditorProvider gomProvider, boolean release) throws IOException
TableTemplate.Mapping
s for this template based on the given GOM provider. The provided entries are safe to change with no feedback to this template.oldMappings
- The old mappings.gomProvider
- The GOM provider object.release
- If true
, returns on release state.IOException
- If the mappings could not be read.void setMappings(TableTemplate.Mapping[] mappings)
TableTemplate.Mapping
s for this template.@NotNull IDProvider.UidType getUidType()
UID_TYPE
.getUidType
in interface IDProvider
UID_TYPE
IDProvider.hasUid()
int getRowHeight()
void setRowHeight(int value)
value
- The height that should be set for the displayed rows.IllegalArgumentException
- if provided value is below 1getRowHeight()
boolean isCopyAllowed()
true
if the user is allowed to copy entities.void setCopyAllowed(boolean value)
value
- new stateisCopyAllowed()
long getTemplateId()
getTemplateId
in interface MasterTemplate
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210