de.espirit.firstspirit.access.store.templatestore

Interface SectionTemplates

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, RootFolder, StoreElement, StoreElementFolder, TemplateContainer<SectionTemplate>, Workflowable

public interface SectionTemplates
extends TemplateContainer<SectionTemplate>, RootFolder

This interface provides methods to handle templates of type section in the TemplateStore

Since:

3.0

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

Field Summary

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

CHANGED, NEVER_RELEASED, RELEASED

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

ALL_REVISIONS, EVER_SINCE, UNTIL_NOW

Method Summary

Methods

Modifier and Type	Method and Description
SectionTemplate	createTemplate(String uid) Create a new template in this folder.
SectionTemplate	createTemplate(String uid, boolean unifyNamesOnServer) Create a new template in this folder.
SectionTemplate	createTemplate(String uid, Map<Language,String> lang2DisplayName, boolean unifyNamesOnServer) Create a new template in this folder.
TemplateFolder<SectionTemplate>	createTemplateFolder(String name) Create a new sub-folder in this folder
TemplateFolder<SectionTemplate>	createTemplateFolder(String name, Map<Language,String> lang2DisplayName) Create a new sub-folder in this folder
SectionTemplate	getTemplate(String uid) Returns page template with the given uid or null.
Class<SectionTemplate>	getTemplateType() Generic type information of the template type this template container may hold.
void	setName(String name) Setting the name has no effect, calls will be ignored.

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, setMeta, setMetaFormData, setUid

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, 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, 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

setName

void setName(String name)

Setting the name has no effect, calls will be ignored.

Since:

3.0

getTemplateType

Class<SectionTemplate> getTemplateType()

Generic type information of the template type this template container may hold.

Specified by:

getTemplateType in interface TemplateContainer<SectionTemplate>

Returns:

the template type this template container may hold

Since:

4.1.24

createTemplateFolder

TemplateFolder<SectionTemplate> createTemplateFolder(@NotNull
                                                   String name)
                                                     throws LockException,
                                                            ElementDeletedException

Create a new sub-folder in this folder

Specified by:

createTemplateFolder in interface TemplateContainer<SectionTemplate>

Parameters:

name - name of the new folder

Returns:

the new created folder

Throws:

LockException

ElementDeletedException

Since:

3.0

createTemplateFolder

TemplateFolder<SectionTemplate> createTemplateFolder(@NotNull
                                                   String name,
                                                   @Nullable
                                                   Map<Language,String> lang2DisplayName)
                                                     throws LockException,
                                                            ElementDeletedException

Create a new sub-folder in this folder

Specified by:

createTemplateFolder in interface TemplateContainer<SectionTemplate>

Parameters:

name - name of the new folder

Returns:

the new created folder

Throws:

LockException

ElementDeletedException

Since:

3.0

createTemplate

SectionTemplate createTemplate(@NotNull
                             String uid)
                               throws LockException,
                                      DuplicateReferenceNameException,
                                      ElementDeletedException

Create a new template in this folder.

Specified by:

createTemplate in interface TemplateContainer<SectionTemplate>

Parameters:

uid - the uid of the new template

Returns:

the new crated template

Throws:

LockException - if this template container is locked in another session

DuplicateReferenceNameException - if a template with the given uid already exists on the server

ElementDeletedException

Since:

3.1.158

createTemplate

SectionTemplate createTemplate(@NotNull
                             String uid,
                             boolean unifyNamesOnServer)
                               throws LockException,
                                      DuplicateReferenceNameException,
                                      ElementDeletedException

Create a new template in this folder. The given uid is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.

Specified by:

createTemplate in interface TemplateContainer<SectionTemplate>

Parameters:

uid - the uid of the new template

unifyNamesOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a template with the given uid already exist

Returns:

the new created template

Throws:

LockException - if this template container is locked in another session

DuplicateReferenceNameException - if a template with the given uid already exists on the server and unifyNamesOnServer == false

ElementDeletedException

Since:

4.0

createTemplate

SectionTemplate createTemplate(@NotNull
                             String uid,
                             @Nullable
                             Map<Language,String> lang2DisplayName,
                             boolean unifyNamesOnServer)
                               throws LockException,
                                      DuplicateReferenceNameException,
                                      ElementDeletedException

Create a new template in this folder. The given uid is used as suggestion if unifyNameOnServer == true and will be unified on the server if it is necessary.

Specified by:

createTemplate in interface TemplateContainer<SectionTemplate>

Parameters:

uid - the uid of the new template

lang2DisplayName - mapping of language to language specific displayname; used to create LanguageInfo nodes

unifyNamesOnServer - if true the given uid will be unified on server if necessary, otherwise a DuplicateReferenceNameException will be thrown, if a template with the given uid already exist

Returns:

the new created template

Throws:

LockException - if this template container is locked in another session

DuplicateReferenceNameException - if a template with the given uid already exists on the server and unifyNamesOnServer == false

ElementDeletedException

Since:

4.0.120

getTemplate

SectionTemplate getTemplate(@NotNull
                          String uid)

Returns page template with the given uid or null.

Specified by:

getTemplate in interface TemplateContainer<SectionTemplate>

Parameters:

uid - unique identifier without type prefix.

Returns:

page template with the given uid or null.

Since:

4.0

See Also:

Store.getStoreElement(String, de.espirit.firstspirit.access.store.IDProvider.UidType)