de.espirit.firstspirit.base.store
Interface PreviewUrl

All Superinterfaces:

UrlProducer

public interface PreviewUrl
extends UrlProducer

Model representing a preview url.

Since:

4.2.16

Nested Class Summary

static class

PreviewUrl.Type The type of the preview url.

Field Summary

static String

PARAMETER_FORCE_REFRESH

Method Summary

String	getBaseUrl() The base url.
long	getEntityId() The entity id.
String	getLanguageAbbreviation() The language abbreviation.
long	getNodeId() The node id.
long	getProjectId() The project id.
long	getRevisionId() The revision id.
long	getSessionId() The id of the session to be used.
long	getTemplateSetId() The template set id.
PreviewUrl.Type	getType() Returns the type of the element to preview.
boolean	isForceRefresh() Flag if a refresh should be forced.
boolean	isForRelease() Indicates whether to preview from release store.
boolean	isFullQualified() Flag if the url is full qualified.
boolean	isSSO() Flag if single-sign-on is used.
boolean	isWebedit() Flag if webedit content should be rendered.

Methods inherited from interface de.espirit.firstspirit.base.UrlProducer

getExternalUrl, toUrl

Field Detail

PARAMETER_FORCE_REFRESH

static final String PARAMETER_FORCE_REFRESH

Since:

4.2.16

See Also:

Constant Field Values

Method Detail

getNodeId

long getNodeId()

The node id.

Returns:

The ID of the node to preview.

Since:

4.2.16

getEntityId

long getEntityId()

The entity id.

Returns:

The ID of the entity to preview.

Since:

4.2.16

getProjectId

long getProjectId()

The project id.

Returns:

The ID of the project to be used.

Since:

4.2.16

getSessionId

long getSessionId()

The id of the session to be used.

Returns:

The ID of the session to be used.

Since:

4.2.16

getRevisionId

long getRevisionId()

The revision id.

Returns:

The ID of the revision to be used.

Since:

4.2.400

getType

PreviewUrl.Type getType()

Returns the type of the element to preview.

Returns:

The type of element to preview.

Since:

4.2.16

getLanguageAbbreviation

String getLanguageAbbreviation()

The language abbreviation.

Returns:

The language to be used.

Since:

4.2.16

getTemplateSetId

long getTemplateSetId()

The template set id.

Returns:

The ID of the template set to be used.

Since:

4.2.16

isForRelease

boolean isForRelease()

Indicates whether to preview from release store.

Returns:

An indicator, whether to preview from release store.

Since:

4.2.16

isForceRefresh

boolean isForceRefresh()

Flag if a refresh should be forced.

Returns:

An indicator, whether a refresh is being forced.

Since:

4.2.16

isSSO

boolean isSSO()

Flag if single-sign-on is used.

Returns:

An indicator, whether to use single-sign-on.

Since:

4.2.16

isWebedit

boolean isWebedit()

Flag if webedit content should be rendered.

Returns:

An indicator, whether this is a webedit request.

Since:

4.2.16

isFullQualified

boolean isFullQualified()

Flag if the url is full qualified.

Returns:

An indicator, whether this URL is full qualified.

Since:

4.2.16

getBaseUrl

String getBaseUrl()

The base url.

Returns:

The base URL for preview use.

Since:

4.2.16