de.espirit.firstspirit.access.project

Interface TemplateSet

public interface TemplateSet

A template set

Since:

3.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOS_LINEFEED
static String	MAC_LINEFEED
static String	UNIX_LINEFEED

Method Summary

Methods

Modifier and Type	Method and Description
ConversionTable	getConversionTable()
String	getDescription(Language language) Get the editorial description of this TemplateSet for the given language or null if not defined for the language
String	getDisplayName(Language language) Gets display name of the TemplateSet for the given language.
String	getExtension() Gets the extension of the TemplateSet
long	getId()
String	getLinefeed() Not evaluated by FirstSpirit.
String	getName() Deprecated. since 4.2.12 use getUid()
PresentationChannel	getPresentationChannel() Gets the PresentationChannel of this TemplateSet
String	getPresentationChannelName() Gets the name of the presentation channel of the template set
String	getTemplateSetConversionTable() Gets the conversion table of the template set
String	getUid() Returns the unique identifier of this TemplateSet.
boolean	isActive() Is this TemplateSet active
boolean	isTemplateInspectionEnabled() Returns whether or not the template inspection is enabled for this template set.
boolean	isUseWebeditForPreview() Deprecated. since 5.0.302 - no replacement
void	setActive(boolean active) Activate or deactivate the TemplateSet
void	setConversionTable(ConversionTable table)
void	setConversionTable(String tableName) Sets the conversion table of the template set
void	setDescription(Language language, String description) Sets the editorial description of this TemplateSet for the given language
void	setDisplayName(Language language, String displayName) Sets the display name of the TemplateSet for the given language
void	setExtension(String extension) Sets the extension of the TemplateSet
void	setLinefeed(String linefeed) Not evaluated by FirstSpirit.
void	setName(String name) Deprecated. since 4.2.12 use setUid(String)
void	setPresentationChannel(String channelName) Sets the PresentationChannel of the TemplateSet
void	setPresentationChannelId(long channel)
void	setTemplateInspectionEnabled(boolean enabled) Enables or disables the template inspection for this template set.
void	setUid(String name) Sets the unique identifier of this TemplateSet.
void	setUseWebeditForPreview(boolean useWebedit) Deprecated. since 5.0.302 - no replacement

Field Detail

DOS_LINEFEED

static final String DOS_LINEFEED

Since:

4.0

See Also:

Constant Field Values

UNIX_LINEFEED

static final String UNIX_LINEFEED

Since:

4.0

See Also:

Constant Field Values

MAC_LINEFEED

static final String MAC_LINEFEED

Since:

4.0

See Also:

Constant Field Values

Method Detail

getName

@Deprecated
String getName()

Deprecated. since 4.2.12 use getUid()

Call getUid()

Since:

3.0

getUid

String getUid()

Returns the unique identifier of this TemplateSet.

Returns:

the uid of this TemplateSet

Since:

4.2.12

See Also:

setUid(String)

setName

@Deprecated
void setName(String name)

Deprecated. since 4.2.12 use setUid(String)

Calls setUid(name)

Since:

3.0

setUid

void setUid(String name)

Sets the unique identifier of this TemplateSet.

Since:

4.2.12

See Also:

getUid()

getDisplayName

@Nullable
String getDisplayName(Language language)

Gets display name of the TemplateSet for the given language.

Parameters:

language -

Returns:

the name or null if not defined

Since:

4.2.12

setDisplayName

void setDisplayName(Language language,
                  String displayName)

Sets the display name of the TemplateSet for the given language

Parameters:

displayName - the new displayname

language - the language to set the display name for

Since:

4.2.12

getDescription

@Nullable
String getDescription(Language language)

Get the editorial description of this TemplateSet for the given language or null if not defined for the language

Parameters:

language - the language to get the description for

Returns:

the description for the given language if defined, null otherwise

Since:

4.2.12

setDescription

void setDescription(Language language,
                  String description)

Sets the editorial description of this TemplateSet for the given language

Parameters:

description - the new description

language - the language to set the description for

Since:

4.2.12

getExtension

String getExtension()

Gets the extension of the TemplateSet

Returns:

the extension value

Since:

3.0

setExtension

void setExtension(String extension)

Sets the extension of the TemplateSet

Parameters:

extension - the new extension

Since:

3.0

getPresentationChannelName

String getPresentationChannelName()

Gets the name of the presentation channel of the template set

Returns:

the presentation channel name

Since:

3.0

setPresentationChannel

void setPresentationChannel(String channelName)

Sets the PresentationChannel of the TemplateSet

Parameters:

channelName - the PresentationChannel identified by its name

Since:

3.0

getPresentationChannel

PresentationChannel getPresentationChannel()

Gets the PresentationChannel of this TemplateSet

Returns:

PresentationChannel of this TemplateSet

Since:

4.0

setPresentationChannelId

void setPresentationChannelId(long channel)

Since:

4.0

isActive

boolean isActive()

Is this TemplateSet active

Returns:

is active

Since:

3.0

setActive

void setActive(boolean active)

Activate or deactivate the TemplateSet

Parameters:

active - activate/deactivate

Since:

3.0

setConversionTable

void setConversionTable(String tableName)

Sets the conversion table of the template set

Parameters:

tableName - the name of the conversion table

Since:

3.0

setConversionTable

void setConversionTable(ConversionTable table)

Since:

4.0

getConversionTable

ConversionTable getConversionTable()

Since:

4.0

getTemplateSetConversionTable

String getTemplateSetConversionTable()

Gets the conversion table of the template set

Returns:

the name of the conversion table

Since:

3.0

getId

long getId()

Since:

4.0

getLinefeed

String getLinefeed()

Not evaluated by FirstSpirit. May be used in ContentProcessor implementations.

Since:

4.0

setLinefeed

void setLinefeed(String linefeed)

Not evaluated by FirstSpirit. May be used in ContentProcessor implementations.

Since:

4.0

setUseWebeditForPreview

@Deprecated
void setUseWebeditForPreview(boolean useWebedit)

Deprecated. since 5.0.302 - no replacement

Since:

4.0

isUseWebeditForPreview

@Deprecated
boolean isUseWebeditForPreview()

Deprecated. since 5.0.302 - no replacement

Since:

4.0

isTemplateInspectionEnabled

boolean isTemplateInspectionEnabled()

Returns whether or not the template inspection is enabled for this template set. If enabled, the preview generation will try to enhance the generated html code with template related attributes. This only works for html based template sets.

Returns:

template inspection enabled state

Since:

5.1.304

setTemplateInspectionEnabled

void setTemplateInspectionEnabled(boolean enabled)

Enables or disables the template inspection for this template set. If enabled, the preview generation will try to enhance the generated html code with template related attributes. This only works for html based template sets.

Parameters:

enabled - template inspection enabled state

Since:

5.1.304