Package de.espirit.firstspirit.access.store.pagestore

Interface DataProvider

All Superinterfaces:

Comparable<StoreElement>, HistoryProvider, IDProvider, StoreElement, Workflowable

All Known Subinterfaces:

Content2Section, Dataset, GCAPage, GCASection, Page, PageRefFolder, ProjectProperties, Section<T>, SectionReference<T>, SiteStoreFolder, SiteStoreRoot

public interface DataProvider
extends IDProvider

Interface providing methods for data access.
Ensure to call setData(de.espirit.firstspirit.access.store.Data) after modifications of the provided data object.

 final DataProvider myDataProvider;
 data = myDataProvider.getData();

 // modifications to the data object

 // reset data object to make changes persistent
 myDataProvider.setData(data);
 

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
void	clearCachedData()	Clear any cache holding the data object.
Data	getData()	Deprecated. since 4.2.440 - use getFormData() instead
@NotNull FormData	getFormData()	Gets the formdata container of this element.
void	setData(Data data)	Deprecated. since 4.2.440 - use setFormData(de.espirit.firstspirit.forms.FormData) instead
void	setFormData(@NotNull FormData formData)	Sets the given formdata container of this element.

Methods inherited from interface java.lang.Comparable

compareTo

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

getData

@Deprecated
Data getData()

Deprecated.

since 4.2.440 - use getFormData() instead

Get the data container of this store element.

Since:

3.0

See Also:

• setData(de.espirit.firstspirit.access.store.Data)

setData

@Deprecated
void setData(Data data)

Deprecated.

since 4.2.440 - use setFormData(de.espirit.firstspirit.forms.FormData) instead

Set the data container of this store element.

Parameters:

data - the new data container

Since:

3.0

clearCachedData

@ApiDoc(comment="Clear any cache holding the data object.",
        since="4.0")
void clearCachedData()

Clear any cache holding the data object.

Since:

4.0

getFormData

@ApiDoc(comment="Gets the formdata container of this element.",
        since="4.2.440")
@NotNull
@NotNull FormData getFormData()

Gets the formdata container of this element.

Returns:

the formdata container of this element.

Since:

4.2.440

setFormData

@ApiDoc(comment="Sets the given formdata container of this element.",
        since="4.2.440")
void setFormData(@NotNull
 @NotNull FormData formData)

Sets the given formdata container of this element.

Parameters:

formData - the form data container to be set to this element

Since:

4.2.440