org.jahia.services.sites

Interface JahiaSite

All Known Implementing Classes:

JCRSiteNode

public interface JahiaSite

Represent a virtual site (web project) in Jahia's context.

Author:

Khue ng

Method Summary

Modifier and Type	Method and Description
List<String>	getAllServerNames() Return the list of accepted server names.
String	getDefaultLanguage()
String	getDescription() Returns the description, provided for this site.
Set<String>	getInactiveLanguages() Returns a set of languages, which are deactivated completely for browsing and editing.
Set<String>	getInactiveLiveLanguages() Returns a set of languages, which are not considered in live mode browsing, i.e.
List<String>	getInstalledModules()
String	getJCRLocalPath()
Set<String>	getLanguages() Returns a List of site language settings.
List<Locale>	getLanguagesAsLocales() Returns an List of site language ( as Locale ).
Set<String>	getMandatoryLanguages()
String	getServerName() Return the Full Qualified Domain Name ( www.jahia.org )
List<String>	getServerNameAliases() Returns a list of additional server names (aliases).
String	getSiteKey() Return the unique String identifier key ( ex: jahia )
String	getTemplateFolder()
String	getTemplatePackageName() Returns the corresponding template set name of this virtual site.
String	getTitle()
boolean	isAllowsUnlistedLanguages()
boolean	isDefault() Returns true if this site is the default one on the server.
boolean	isMixLanguagesActive()
void	setAllowsUnlistedLanguages(boolean allowsUnlistedLanguages)
void	setDefaultLanguage(String defaultLanguage)
void	setDescr(String descr)
void	setDescription(String description)
void	setInactiveLanguages(Set<String> inactiveLanguages) Sets languages, which are completely deactivated for browsing and editing.
void	setInactiveLiveLanguages(Set<String> inactiveLiveLanguages) Sets languages, which are not considered in live mode browsing, i.e.
void	setInstalledModules(List<String> installedModules)
void	setLanguages(Set<String> languages) Sets the language settings for this site.
void	setMandatoryLanguages(Set<String> mandatoryLanguages)
void	setMixLanguagesActive(boolean mixLanguagesActive) Sets the value of the site property that controls
void	setServerName(String name) Set the Full Qualified Domain Name ( www.jahia.org )
void	setServerNameAliases(List<String> names) Sets a list of additional server names (aliases).
void	setTitle(String value)

Method Detail

getDefaultLanguage

String getDefaultLanguage()

getDescription

String getDescription()

Returns the description, provided for this site.

Returns:

the description, provided for this site

getInactiveLanguages

Set<String> getInactiveLanguages()

Returns a set of languages, which are deactivated completely for browsing and editing.

Returns:

a set of languages, which are deactivated completely for browsing and editing

getInactiveLiveLanguages

Set<String> getInactiveLiveLanguages()

Returns a set of languages, which are not considered in live mode browsing, i.e. are currently inactive in navigation.

Returns:

a set of languages, which are not considered in live mode browsing, i.e. are currently inactive in navigation

getInstalledModules

List<String> getInstalledModules()

getLanguages

Set<String> getLanguages()

Returns a List of site language settings. The order of this List corresponds to the ranking of the languages.

Returns:

a List containing String elements.

getLanguagesAsLocales

List<Locale> getLanguagesAsLocales()

Returns an List of site language ( as Locale ).

Returns:

an List of Locale elements.

getMandatoryLanguages

Set<String> getMandatoryLanguages()

getServerName

String getServerName()

Return the Full Qualified Domain Name ( www.jahia.org )

getServerNameAliases

List<String> getServerNameAliases()

Returns a list of additional server names (aliases).

Returns:

list of additional server names (aliases)

getAllServerNames

List<String> getAllServerNames()

Return the list of accepted server names.

getSiteKey

String getSiteKey()

Return the unique String identifier key ( ex: jahia )

getTemplatePackageName

String getTemplatePackageName()

Returns the corresponding template set name of this virtual site.

Returns:

the corresponding template set name of this virtual site

getTemplateFolder

String getTemplateFolder()

getTitle

String getTitle()

isDefault

boolean isDefault()

Returns true if this site is the default one on the server.

Returns:

true if this site is the default one on the server

isMixLanguagesActive

boolean isMixLanguagesActive()

isAllowsUnlistedLanguages

boolean isAllowsUnlistedLanguages()

setDefaultLanguage

void setDefaultLanguage(String defaultLanguage)

setDescr

void setDescr(String descr)

setDescription

void setDescription(String description)

setInactiveLanguages

void setInactiveLanguages(Set<String> inactiveLanguages)

Sets languages, which are completely deactivated for browsing and editing.

Parameters:

inactiveLanguages - the set of inactive languages

setInactiveLiveLanguages

void setInactiveLiveLanguages(Set<String> inactiveLiveLanguages)

Sets languages, which are not considered in live mode browsing, i.e. are currently inactive in navigation.

Parameters:

inactiveLiveLanguages - the set of inactive languages

setInstalledModules

void setInstalledModules(List<String> installedModules)

setLanguages

void setLanguages(Set<String> languages)

Sets the language settings for this site. This directly interfaces with the persistant storage to store the modifications if there were any.

setMandatoryLanguages

void setMandatoryLanguages(Set<String> mandatoryLanguages)

setMixLanguagesActive

void setMixLanguagesActive(boolean mixLanguagesActive)

Sets the value of the site property that controls

Parameters:

mixLanguagesActive - true or false

setAllowsUnlistedLanguages

void setAllowsUnlistedLanguages(boolean allowsUnlistedLanguages)

setServerName

void setServerName(String name)

Set the Full Qualified Domain Name ( www.jahia.org )

setServerNameAliases

void setServerNameAliases(List<String> names)

Sets a list of additional server names (aliases).

Parameters:

names - a list of additional server names (aliases)

setTitle

void setTitle(String value)

getJCRLocalPath

String getJCRLocalPath()