LiveSite

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.bemoko.live.platform.mwc.sites
Interface LiveSite

All Superinterfaces:: Cloneable, Inheritable, Serializable

public interface LiveSite
extends Serializable, Inheritable, Cloneable
extends Serializable, Inheritable, Cloneable

Field Summary
`static String`	`UI_CONFIG_FILE`
`static String`	`UI_DIRECTORY`

Method Summary
`void`	`addSiteScopedPlugin(String pluginUniqueName, LivePlugin plugin)`
`boolean`	`deepFallbackContains(String name)`
`LiveSiteConfiguration`	`getConfiguration()` Get the configuration of the site
`String`	`getContainerName()`
`String`	`getHome()` Get the site home location, i.e.
`LiveConfigIntent`	`getIntent(String intent)`
`LiveConfigIntent`	`getIntentByType(String type)` Get resource intent
`long`	`getLastModified()`
`Locale`	`getLocale()`
`LocaleContext`	`getLocaleContext()`
`String`	`getName()` Get the name of the site.
`String`	`getOperationalMode()` Deprecated.
`String`	`getPlatformRelativeUri()` Get site URI, starting with a "/" and relative to the platform.
`LiveSite`	`getRootContainer()` Deprecated.
`String`	`getRootContainerName()`
`LivePlugin`	`getSiteScopedPlugin(String pluginUniqueName)`
`Map<String,String>`	`getSubsiteNames()`
`boolean`	`isEnabled()`
`void`	`setLastModified(long timestamp)`

Methods inherited from interface com.bemoko.live.platform.mwc.inheritance.Inheritable
`getDeepFallbackNameList, getDeepFallbackPath, getFallback, getFallbackName, getFallbackNameList, getFallbackPath, getFirstFallbackName, getInheritance, getLocation, getParent, getSiteNameWithoutInheritance, hasNoInheritance, isSelfInFallback`

Field Detail

UI_DIRECTORY

static final String UI_DIRECTORY

See Also:: Constant Field Values

UI_CONFIG_FILE

static final String UI_CONFIG_FILE

See Also:: Constant Field Values

Method Detail

getConfiguration

LiveSiteConfiguration getConfiguration()

Get the configuration of the site

getName

String getName()

Get the name of the site. In the case of sub-sites this name is the full site name relative to the platform e.g. test~subsite~subsubsite

Specified by:: getName in interface Inheritable

getPlatformRelativeUri

String getPlatformRelativeUri()

Get site URI, starting with a "/" and relative to the platform. For example if site name is "site~subsite" the the platform relative URI would be "/site/subsite"

getIntentByType

LiveConfigIntent getIntentByType(String type)
                                 throws com.bemoko.live.platform.mwc.LiveSiteException

Get resource intent

Throws:: com.bemoko.live.platform.mwc.LiveSiteException

getIntent

LiveConfigIntent getIntent(String intent)
                           throws com.bemoko.live.platform.mwc.LiveSiteException

Throws:: com.bemoko.live.platform.mwc.LiveSiteException

getSubsiteNames

Map<String,String> getSubsiteNames()

getContainerName

String getContainerName()

Returns:: the container to this site. This refers to the direct container site of sub-site. For actual inheritance @see #getFallback()

getRootContainerName

String getRootContainerName()

Returns:: the root container to this site. This refers to the top level container site of a sub-site, or the current site object if this is a top level container

getRootContainer

@Deprecated
LiveSite getRootContainer()

Deprecated.

getHome

String getHome()

Get the site home location, i.e. the location of the configuration and resource files

getOperationalMode

@Deprecated
String getOperationalMode()