Package de.espirit.firstspirit.access.store.globalstore

Interface ProjectProperties

All Superinterfaces:

Comparable<StoreElement>, DataProvider, HistoryProvider, IDProvider, StoreElement, TemplateProvider<PageTemplate>, Workflowable

public interface ProjectProperties
extends IDProvider, DataProvider, TemplateProvider<PageTemplate>

Interface providing means to operate on project properties.

Project properties can be retrieved by calling GlobalStoreRoot.getProjectProperties().

Since:

3.0

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

Method Summary

Modifier and Type	Method	Description
@NotNull PageTemplate	getTemplate()	Returns the template for this project properties or throws a ReferenceNotFoundException if no template is defined or defined template couldn't be found.
boolean	isTemplateDefined()	Indicates whether a project properties template is defined or not.
void	setTemplate(@Nullable PageTemplate template)	Sets the template for this project properties.

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

getTemplate

@NotNull
@NotNull PageTemplate getTemplate()
                           throws ReferenceNotFoundException

Returns the template for this project properties or throws a ReferenceNotFoundException if no template is defined or defined template couldn't be found.

Specified by:

getTemplate in interface TemplateProvider<PageTemplate>

Returns:

the template of type <T>

Throws:

ReferenceNotFoundException - if the template is missing

Since:

3.0

See Also:

• setTemplate(de.espirit.firstspirit.access.store.templatestore.PageTemplate)
• isTemplateDefined()

setTemplate

void setTemplate(@Nullable
 @Nullable PageTemplate template)

Sets the template for this project properties.

Parameters:

template - new template or null

Since:

4.1.25

See Also:

• getTemplate()

isTemplateDefined

boolean isTemplateDefined()

Indicates whether a project properties template is defined or not. If this method returns false a call of getTemplate() will throw a ReferenceNotFoundException

Returns:

true if a template is defined for this project properties, false otherwise

Since:

4.2.33

See Also:

• getTemplate()