de.espirit.firstspirit.access.editor.reference

Interface Reference

public interface Reference

A reference is either an internal reference (e.g. "media:logo"), a remote reference (e.g. "media:logo, remote:MainProject") or an external reference (e.g. "http://www.google.com").

A reference is broken if the reference name couldn't be found.

Since:

3.1.158

See Also:

isBroken(), isRemote()

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_LINK
static List<Reference>	EMPTY_REFERENCE_LIST An unmodifyable empty reference list.
static String	EXTERNAL_LINK
static String	INTERNAL_LINK
static String	LINK_TEMPLATE_REFERENCE
static String	PAGE_TEMPLATE_REFERENCE
static String	QUERY_REFERENCE Type string identifying a reference to a Query
static String	RELATED_PROJECT_LINK
static String	RENDER_TEMPLATE_REFERENCE
static String	SECTION_TEMPLATE_REFERENCE
static String	TABLE_TEMPLATE_REFERENCE

Method Summary

Methods

Modifier and Type	Method and Description
Language	getLanguage()
Object	getReferencedObject()
Store.Type	getReferencedStoreType()
ReferenceEntry	getReferenceEntry() Deprecated. since 4.2.24 - no replacement
ReferenceEntry	getReferenceEntry(UserService userService, boolean release) Returns reference entry.
String	getReferenceString()
String	getRemoteName()
String	getTypeName()
boolean	isBroken() Internal references may be broken, e.g.
boolean	isRemote()
void	setReferencedObject(Object value) Sets the (local) referenced object.
void	setReferencedObject(String remote, Object value) Deprecated. since 4.2.24 - no op operation - use setReferencedObject(Object)

Field Detail

EMPTY_REFERENCE_LIST

static final List<Reference> EMPTY_REFERENCE_LIST

An unmodifyable empty reference list.

Since:

4.2.24

SECTION_TEMPLATE_REFERENCE

static final String SECTION_TEMPLATE_REFERENCE

Since:

3.1.158

See Also:

Constant Field Values

PAGE_TEMPLATE_REFERENCE

static final String PAGE_TEMPLATE_REFERENCE

Since:

3.1.158

See Also:

Constant Field Values

LINK_TEMPLATE_REFERENCE

static final String LINK_TEMPLATE_REFERENCE

Since:

3.1.158

See Also:

Constant Field Values

RENDER_TEMPLATE_REFERENCE

static final String RENDER_TEMPLATE_REFERENCE

Since:

3.1.158

See Also:

Constant Field Values

TABLE_TEMPLATE_REFERENCE

static final String TABLE_TEMPLATE_REFERENCE

Since:

4.2.24

See Also:

Constant Field Values

INTERNAL_LINK

static final String INTERNAL_LINK

Since:

4.2.24

See Also:

Constant Field Values

EXTERNAL_LINK

static final String EXTERNAL_LINK

Since:

4.2.24

See Also:

Constant Field Values

CONTENT_LINK

static final String CONTENT_LINK

Since:

4.2.24

See Also:

Constant Field Values

RELATED_PROJECT_LINK

static final String RELATED_PROJECT_LINK

Since:

4.2.24

See Also:

Constant Field Values

QUERY_REFERENCE

static final String QUERY_REFERENCE

Type string identifying a reference to a Query

Since:

4.2.410

See Also:

Constant Field Values

Method Detail

getTypeName

String getTypeName()

Returns:

One of the following values:

• INTERNAL_LINK
• EXTERNAL_LINK
• CONTENT_LINK
• RELATED_PROJECT_LINK
• SECTION_TEMPLATE_REFERENCE
• PAGE_TEMPLATE_REFERENCE
• LINK_TEMPLATE_REFERENCE
• RENDER_TEMPLATE_REFERENCE

Since:

3.1.158

getLanguage

Language getLanguage()

Since:

3.1.158

getReferencedObject

Object getReferencedObject()

Returns:

The url for external references, the referenced StoreElement for internal references, or null for broken references.

Since:

3.1.158

getRemoteName

String getRemoteName()

Returns:

symbolic name of the remote project or null for a non-remote reference.

Since:

3.1.324

setReferencedObject

void setReferencedObject(Object value)

Sets the (local) referenced object.

Parameters:

value - new referenced object.

Since:

3.1.158

setReferencedObject

@Deprecated
void setReferencedObject(String remote,
                                  Object value)

Deprecated. since 4.2.24 - no op operation - use setReferencedObject(Object)

Since:

3.1.324

isBroken

boolean isBroken()

Internal references may be broken, e.g. "media:logo" when no media object with the name "logo" exists. Use getReferenceString() to get more information for the desired target.
The target of external references is not checked, e.g if an invalid url is specified for an external reference, isBroken() returns false.

Returns:

true if this is an internal reference and the target does not exist

Since:

3.1.172

isRemote

boolean isRemote()

Returns:

true if this reference is a remote reference.

Since:

3.1.324

getReferenceString

String getReferenceString()

Returns:

The reference string, e.g. "media:logo" for an internal reference or "http://www.google.com" for external reference

Since:

3.1.172

getReferencedStoreType

Store.Type getReferencedStoreType()

Returns:

The store type for internal references and null for external references.

Since:

4.0.17

getReferenceEntry

@Deprecated
ReferenceEntry getReferenceEntry()

Deprecated. since 4.2.24 - no replacement

Returns null.

Since:

3.1.324

getReferenceEntry

ReferenceEntry getReferenceEntry(UserService userService,
                               boolean release)

Returns reference entry.

Since:

4.2.24