de.espirit.firstspirit.access.store

Interface Previewable

All Superinterfaces:

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

All Known Subinterfaces:

DocumentGroup, GCAPage, Page, PageRef

public interface Previewable
extends IDProvider

Since:

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

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

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
String	getPreviewUrl(Language language, TemplateSet templateSet, boolean release, int mode, Map<?,?> params) Returns the preview url of this store element.
PreviewUrl	getPreviewUrlObject(Language language, TemplateSet templateSet, boolean release, int mode, Map<?,?> params) Returns the preview url object of this store element.

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

Field Detail

PREVIEWMODE_NONE

static final int PREVIEWMODE_NONE

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_FORCE_REFRESH

static final int PREVIEWMODE_FORCE_REFRESH

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_SSO

static final int PREVIEWMODE_SSO

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_FULL_QUALIFIED

static final int PREVIEWMODE_FULL_QUALIFIED

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_WEBEDIT

static final int PREVIEWMODE_WEBEDIT

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_WITHOUT_CONTEXTNAME

static final int PREVIEWMODE_WITHOUT_CONTEXTNAME

Since:

4.0.120

See Also:

Constant Field Values

PREVIEWMODE_DEFAULT

static final int PREVIEWMODE_DEFAULT

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_DEFAULT_REFRESH

static final int PREVIEWMODE_DEFAULT_REFRESH

Since:

4.0.17

See Also:

Constant Field Values

PREVIEWMODE_WEBEDIT_FULL_QUALIFIED

static final int PREVIEWMODE_WEBEDIT_FULL_QUALIFIED

Since:

4.0.55

See Also:

Constant Field Values

PARAM_REVISION

static final String PARAM_REVISION

Since:

4.0.17

See Also:

Constant Field Values

Method Detail

getPreviewUrl

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

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

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

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