org.gatein.api.site

Interface Site

All Superinterfaces:

Comparable<Site>, Describable, Displayable, Serializable

public interface Site
extends Displayable, Describable, Comparable<Site>, Serializable

Represents a portal site. A portal site can be a standard site, a group space or a user dashboard. Any chances to a site is not perisisted until Portal.saveSite(Site) is invoked.

Author:

Nick Scavelli

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Site.AttributeKeys Contains attribute keys for default site attributes

Method Summary

Methods

Modifier and Type	Method and Description
Permission	getAccessPermission() The permissions that represents what users are allowed to access the site
Attributes	getAttributes() Returns the attributes (properties) associated with the site
Permission	getEditPermission() The permissions that represents what users are allowed to modify the site
SiteId	getId() Returns the id of the site
Locale	getLocale() Returns the default locale associated with the site
String	getName() Returns the name of the site
String	getSkin() Returns the skin associated with the site
SiteType	getType() Returns the type of the site.
void	setAccessPermission(Permission permission) Changes the access permission for the site
void	setEditPermission(Permission permission) Changes the edit permission for the site
void	setLocale(Locale locale) Changes the default locale associated with the site
void	setSkin(String skin) Changes the skin associated with the site

Methods inherited from interface org.gatein.api.common.Displayable

getDisplayName, setDisplayName

Methods inherited from interface org.gatein.api.common.Describable

getDescription, setDescription

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

SiteId getId()

Returns the id of the site

Returns:

the id of the site

getType

SiteType getType()

Returns the type of the site. This can be a standard site, a group space or a user dashboard.

Returns:

the type of the site

getName

String getName()

Returns the name of the site

Returns:

the name of the site

getLocale

Locale getLocale()

Returns the default locale associated with the site

Returns:

the locale

setLocale

void setLocale(Locale locale)

Changes the default locale associated with the site

Parameters:

locale -

getSkin

String getSkin()

Returns the skin associated with the site

Returns:

the skin

setSkin

void setSkin(String skin)

Changes the skin associated with the site

Parameters:

skin - the skin

getAttributes

Attributes getAttributes()

Returns the attributes (properties) associated with the site

Returns:

the attributes for this site

getAccessPermission

Permission getAccessPermission()

The permissions that represents what users are allowed to access the site

Returns:

the access permission

setAccessPermission

void setAccessPermission(Permission permission)

Changes the access permission for the site

Parameters:

permission - the access permission

getEditPermission

Permission getEditPermission()

The permissions that represents what users are allowed to modify the site

Returns:

the edit permission

setEditPermission

void setEditPermission(Permission permission)

Changes the edit permission for the site

Parameters:

permission - the edit permission