Package de.espirit.firstspirit.access.store

Interface Previewable

All Superinterfaces:

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

All Known Subinterfaces:

DocumentGroup, GCAPage, Page, PageRef

@Deprecated
public interface Previewable
extends IDProvider

Deprecated.

since 5.2.190105, please use PreviewUrlAgent.getContentProducerBuilder() or PreviewUrlAgent.getMediaBuilder() to create preview urls. The builder can be used to create preview urls for elements of type Page, PageRef or DocumentGroup.

Since:

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

Modifier and Type	Field	Description
static final String	PARAM_REVISION	Deprecated.
static final int	PREVIEWMODE_DEFAULT	Deprecated.
static final int	PREVIEWMODE_DEFAULT_REFRESH	Deprecated.
static final int	PREVIEWMODE_FORCE_REFRESH	Deprecated.
static final int	PREVIEWMODE_FULL_QUALIFIED	Deprecated.
static final int	PREVIEWMODE_NONE	Deprecated.
static final int	PREVIEWMODE_SSO	Deprecated.
static final int	PREVIEWMODE_WEBEDIT	Deprecated.
static final int	PREVIEWMODE_WEBEDIT_FULL_QUALIFIED	Deprecated.
static final int	PREVIEWMODE_WITHOUT_CONTEXTNAME	Deprecated.

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
String	getPreviewUrl(Language language, TemplateSet templateSet, boolean release, int mode, Map<?,?> params)	Deprecated. since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrl(ContentProducer)
PreviewUrl	getPreviewUrlObject(@Nullable Language language, TemplateSet templateSet, boolean release, int mode, Map<?,?> params)	Deprecated. since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrlObject(ContentProducer)

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, getReleaseRevision, getReleaseStatus, getReleaseStatus, getRevision, getUid, getUidType, 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.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, 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

Field Details

PREVIEWMODE_NONE

static final int PREVIEWMODE_NONE

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_FORCE_REFRESH

static final int PREVIEWMODE_FORCE_REFRESH

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_SSO

static final int PREVIEWMODE_SSO

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_FULL_QUALIFIED

static final int PREVIEWMODE_FULL_QUALIFIED

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_WEBEDIT

static final int PREVIEWMODE_WEBEDIT

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_WITHOUT_CONTEXTNAME

static final int PREVIEWMODE_WITHOUT_CONTEXTNAME

Deprecated.

Since:

4.0.120

See Also:

• Constant Field Values

PREVIEWMODE_DEFAULT

static final int PREVIEWMODE_DEFAULT

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_DEFAULT_REFRESH

static final int PREVIEWMODE_DEFAULT_REFRESH

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

PREVIEWMODE_WEBEDIT_FULL_QUALIFIED

static final int PREVIEWMODE_WEBEDIT_FULL_QUALIFIED

Deprecated.

Since:

4.0.55

See Also:

• Constant Field Values

PARAM_REVISION

static final String PARAM_REVISION

Deprecated.

Since:

4.0.17

See Also:

• Constant Field Values

Method Details

getPreviewUrl

@Deprecated
String getPreviewUrl(Language language,
 TemplateSet templateSet,
 boolean release,
 int mode,
 Map<?,?> params)

Deprecated.

since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrl(ContentProducer)

Returns the preview url of this store element.

Parameters:

language - the requested preview language (may be null)

templateSet - the requested preview template set (may be null)

release - released or current version of preview

mode - combination of PREVIEWMODE_FORCE_REFRESH, PREVIEWMODE_SSO, PREVIEWMODE_FULL_QUALIFIED, and PREVIEWMODE_WEBEDIT

params - additional preview params, may be null - for valid params see overriding methods

Returns:

preview url or null if the url cannot be determined

Since:

4.0

getPreviewUrlObject

@Deprecated
PreviewUrl getPreviewUrlObject(@Nullable
 @Nullable Language language,
 TemplateSet templateSet,
 boolean release,
 int mode,
 Map<?,?> params)

Deprecated.

since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrlObject(ContentProducer)

Returns the preview url object of this store element.

Parameters:

language - the requested preview language (may be null)

templateSet - the requested preview template set (may be null)

release - released or current version of preview

mode - combination of PREVIEWMODE_FORCE_REFRESH, PREVIEWMODE_SSO, PREVIEWMODE_FULL_QUALIFIED, and PREVIEWMODE_WEBEDIT

params - additional preview params, may be null - for valid params see overriding methods

Returns:

the preview url object

Since:

4.2.16