de.espirit.firstspirit.access

Interface ReferenceEntry

All Superinterfaces:

Serializable

public interface ReferenceEntry
extends Serializable

Since:

3.1.172

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_REFERENCE Reference from/to an Entity.
static int	CONTENT_STORE_REFERENCE Reference from/to a content-store element.
static int	EXTERNAL_REFERENCE External reference.
static int	GLOBAL_STORE_REFERENCE Reference from/to a global-store element.
static int	MEDIA_STORE_REFERENCE Reference from/to a media-store element.
static int	PAGE_STORE_REFERENCE Reference from/to a page-store element.
static int	RELATED_PROJECT_REFERENCE Reference from/to related project (this type is always combined with another type).
static int	RENDER_TEMPLATE_REFERENCE template:"name", e.g. in $CMS_RENDER(template:"",
static int	SCRIPT_REFERENCE script:"name", e.g. in $CMS_RENDER(script:"",
static int	SITE_STORE_FOLDER_REFERENCE pagefolder:"name", e.g. in $CMS_RENDER(pagefolder:"name",
static int	SITE_STORE_REFERENCE Reference from/to a site-store element.
static int	STORE_ELEMENT_REFERENCE Reference from/to a store element.
static int	TEMPLATE_STORE_REFERENCE Reference from/to a template-store element.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDisplayText() Return a type dependent display text.
long	getId()
long	getProjectId()
IDProvider	getReferencedElement()
Object	getReferencedObject()
String	getReferenceString()
boolean	getRelease()
String	getRemote() Returns symbolic name of remote configuration.
Store.Type	getStoreType() Returns store-type of the referenced element or null, e.g. for external references.
int	getType() Get the type of this reference.
ReferenceEntry[]	getUsages() Returns usages of this reference.
boolean	isBroken() A reference may be broken, e.g. if a medium was referenced from a picture input component and the medium was deleted afterwards.
boolean	isRemote()
boolean	isType(int type) Returns true if this element is of the given type.
void	refresh() Refreshes this reference entry, e.g. by removing cached objects, recalculating broken status or refreshing referenced elements.

Field Detail

PAGE_STORE_REFERENCE

static final int PAGE_STORE_REFERENCE

Reference from/to a page-store element.

Since:

3.1.324

See Also:

Constant Field Values

SITE_STORE_REFERENCE

static final int SITE_STORE_REFERENCE

Reference from/to a site-store element.

Since:

3.1.324

See Also:

Constant Field Values

MEDIA_STORE_REFERENCE

static final int MEDIA_STORE_REFERENCE

Reference from/to a media-store element.

Since:

3.1.324

See Also:

Constant Field Values

TEMPLATE_STORE_REFERENCE

static final int TEMPLATE_STORE_REFERENCE

Reference from/to a template-store element.

Since:

3.1.324

See Also:

Constant Field Values

GLOBAL_STORE_REFERENCE

static final int GLOBAL_STORE_REFERENCE

Reference from/to a global-store element.

Since:

3.1.324

See Also:

Constant Field Values

CONTENT_STORE_REFERENCE

static final int CONTENT_STORE_REFERENCE

Reference from/to a content-store element.

Since:

3.1.324

See Also:

Constant Field Values

CONTENT_REFERENCE

static final int CONTENT_REFERENCE

Reference from/to an Entity.

Since:

4.0

See Also:

Constant Field Values

RELATED_PROJECT_REFERENCE

static final int RELATED_PROJECT_REFERENCE

Reference from/to related project (this type is always combined with another type).

Since:

3.1.324

See Also:

Constant Field Values

RENDER_TEMPLATE_REFERENCE

static final int RENDER_TEMPLATE_REFERENCE

template:"name", e.g. in $CMS_RENDER(template:"", ..)$

Since:

4.0

See Also:

Constant Field Values

SCRIPT_REFERENCE

static final int SCRIPT_REFERENCE

script:"name", e.g. in $CMS_RENDER(script:"", ..)$

Since:

4.0

See Also:

Constant Field Values

SITE_STORE_FOLDER_REFERENCE

static final int SITE_STORE_FOLDER_REFERENCE

pagefolder:"name", e.g. in $CMS_RENDER(pagefolder:"name", ..)$

Since:

4.0.43

See Also:

Constant Field Values

EXTERNAL_REFERENCE

static final int EXTERNAL_REFERENCE

External reference.

Since:

3.1.324

See Also:

Constant Field Values

STORE_ELEMENT_REFERENCE

static final int STORE_ELEMENT_REFERENCE

Reference from/to a store element.

Since:

3.1.324

See Also:

Constant Field Values

Method Detail

isType

boolean isType(int type)

Returns true if this element is of the given type. If type contains the related project flag this reference has to be external to return true.

getType(MEDIA_STORE_ELEMENT|CONTENT_STORE_REFERENCE) returns true iff this reference is a reference to a media- or a content-store element (media or content). getType(MEDIA_STORE_ELEMENT|RELATED_PROJECT_REFERENCE) returns true iff this reference is an external reference to a media-store element (external and media).

Parameters:

type - PAGE_STORE_REFERENCE, etc.

Returns:

true if this element is of the given type, otherwise returns false.

Since:

3.1.324

getType

int getType()

Get the type of this reference.

Returns:

type of this reference.

Since:

3.1.324

getId

long getId()

Returns:

The id of the referenced node (store-element).

Since:

3.1.172

getProjectId

long getProjectId()

Returns:

Project id of the referenced element.

Since:

3.1.324

getRelease

boolean getRelease()

Returns:

true if the node is from the release store

Since:

3.1.172

getReferencedObject

@Nullable
Object getReferencedObject()

Returns:

The referenced node, may be null if the node is not or no longer visible in the current session or has been deleted or the reference is broken.

Since:

3.1.324

getReferencedElement

@Nullable
IDProvider getReferencedElement()

Returns:

The referenced node, may be null if the node is not or no longer visible in the current session, or has been deleted, or the reference is broken, or referenced object is not an IDProvider.

Since:

4.0

getReferenceString

@Nullable
String getReferenceString()

Returns:

the reference name, e.g. "media:logo" or null if the referenced object cannot be referenced by name

Since:

3.1.324

getDisplayText

String getDisplayText()

Return a type dependent display text.

Since:

4.2

isBroken

boolean isBroken()

A reference may be broken, e.g. if a medium was referenced from a picture input component and the medium was deleted afterwards.

Since:

3.1.172

isRemote

boolean isRemote()

Returns:

true if this reference is a remote reference.

Since:

3.1.324

getRemote

@Nullable
String getRemote()

Returns symbolic name of remote configuration.

Returns:

symbolic name of remote configuration.

Since:

4.2.200

See Also:

UserService.getRemoteUserService(String), RemoteProjectConfiguration

getUsages

ReferenceEntry[] getUsages()

Returns usages of this reference. E.g. in case of a broken reference this method returns references to elements where this broken reference is still in use (and still broken).

Returns:

usages of this reference.

Since:

4.0

getStoreType

@Nullable
Store.Type getStoreType()

Returns store-type of the referenced element or null, e.g. for external references.

Returns:

store-type of the referenced element or null, e.g. for external references.

Since:

4.2.200

refresh

void refresh()

Refreshes this reference entry, e.g. by removing cached objects, recalculating broken status or refreshing referenced elements.

Since:

4.2.406