org.alfresco.wcm.client

Interface WebSite

All Superinterfaces:

Serializable

All Known Implementing Classes:

WebSiteImpl

public interface WebSite
extends Serializable

Web Site Interface

Author:

Roy Wetherall

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_IS_EDITORIAL
static String	PROP_CONTEXT
static String	PROP_HOSTNAME Property constants
static String	PROP_HOSTPORT
static String	PROP_SITE_CONFIG

Method Summary

Methods

Modifier and Type	Method and Description
Asset	getAssetByPath(String path)
Map<String,String>	getConfig() Obtain the map of configuration properties set on this website.
String	getContext() Get context of the webapp used to deliver this site.
String	getDescription() Get the web site's title
String	getHostName() Gets the host name
int	getHostPort() Gets the host port
String	getId() Obtain the identifier of this website
Asset	getLogo() Get the asset which is the site logo
Section	getRootSection() Gets the web sites root section
Section	getSectionByPath(String path) Get a section by path
List<Section>	getSections() Gets the child sections.
String	getTitle() Get the web site's title
UgcService	getUgcService() Get the UGC service
boolean	isEditorialSite() Returns true if this website has been marked as an editorial site.
PathResolutionDetails	resolvePath(String path)

Field Detail

PROP_HOSTNAME

static final String PROP_HOSTNAME

Property constants

See Also:

Constant Field Values

PROP_HOSTPORT

static final String PROP_HOSTPORT

See Also:

Constant Field Values

PROP_CONTEXT

static final String PROP_CONTEXT

See Also:

Constant Field Values

PROP_SITE_CONFIG

static final String PROP_SITE_CONFIG

See Also:

Constant Field Values

CONFIG_IS_EDITORIAL

static final String CONFIG_IS_EDITORIAL

See Also:

Constant Field Values

Method Detail

getHostName

String getHostName()

Gets the host name

Returns:

String host name

getHostPort

int getHostPort()

Gets the host port

Returns:

int host port

getRootSection

Section getRootSection()

Gets the web sites root section

Returns:

Section root section

resolvePath

PathResolutionDetails resolvePath(String path)

getAssetByPath

Asset getAssetByPath(String path)

Parameters:

path -

Returns:

getSections

List<Section> getSections()

Gets the child sections.

Returns:

List

child sections

getId

String getId()

Obtain the identifier of this website

Returns:

getTitle

String getTitle()

Get the web site's title

Returns:

getDescription

String getDescription()

Get the web site's title

Returns:

getLogo

Asset getLogo()

Get the asset which is the site logo

Returns:

getUgcService

UgcService getUgcService()

Get the UGC service

Returns:

getSectionByPath

Section getSectionByPath(String path)

Get a section by path

Parameters:

path -

Returns:

getContext

String getContext()

Get context of the webapp used to deliver this site. The context, together with the host name and host port, is used to generate absolute URLs for assets in this site when necessary

Returns:

getConfig

Map<String,String> getConfig()

Obtain the map of configuration properties set on this website.

Returns:

isEditorialSite

boolean isEditorialSite()

Returns true if this website has been marked as an editorial site. May be used by templates to enable editorial features on the website.

Returns: