org.apache.jetspeed.spaces
Interface Space

public interface Space

Space object represents a single space in the Jetspeed site or somewhere else

Version:

$Id: Space.java 926722 2010-03-23 18:50:44Z woonsan $

Author:

David Sean Taylor

Field Summary

static java.lang.String	META_SPACE_DOMAIN_PATH
static java.lang.String	META_SPACE_IMAGE
static java.lang.String	META_SPACE_OWNER

Method Summary

void	addSecuredGroup(java.lang.String group) Add a group to the list of required group to view this space
void	addSecuredRole(java.lang.String role) Add a role to the list of required roles to view this space
void	addSecuredUser(java.lang.String user) Add a username to the list of users who can view this page
java.lang.String	getDashboard() Retrieves the default dashboard for this space.
java.lang.String	getDescription() Retrieve the description of this space
java.lang.String	getDescription(java.util.Locale locale) Retrieve the description of this space
java.lang.String	getDomainPath() Retrieves the domain path associated with this space For example, employees.localhost.com, or employees.* where * is the SERVER_NAME of this request
java.lang.String	getImage() Retrieves the image associated with this space
java.lang.String	getName() Retrieve the name of the space
java.lang.String	getOwner() Retrieves the owner, a portal user name, for this space
java.lang.String	getPath() Retrieve the path of the space, which can be implementation specific
java.util.List<java.lang.String>	getSecuredGroup() Retrieve the list of secured groups constraining access to this space
java.util.List<java.lang.String>	getSecuredRoles() Retrieve the list of secured roles constraining access to this space
java.util.List<java.lang.String>	getSecuredUsers() Retrieve the list of secured users constraining access to this space
java.lang.String	getSecurityConstraint() Get the security constraint on this space
java.lang.String	getShortTitle() Retrieve the unlocalized short title of the space
java.lang.String	getShortTitle(java.util.Locale locale) Retrieve the localized short title of the space for the requested locale
java.lang.String	getTheme() Retrieves the theme name for this space
java.lang.String	getTitle() Retrieve the unlocalized title of the space
java.lang.String	getTitle(java.util.Locale locale) Retrieve the localized title of the space for the requested locale
void	removeSecuredGroup(java.lang.String group) Remove a group from the list of required roles to view this space
void	removeSecuredRole(java.lang.String role) Remove a role from the list of required roles to view this space
void	removeSecuredUser(java.lang.String user) Remove a user from the list of required users to view this space
void	setDashboard(java.lang.String dashboard) Sets the dashboard for this space.
void	setDescription(java.lang.String description) Sets the description on this space
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the description on this space
void	setDomainPath(java.lang.String domain) Sets the domain path associated with this space For example, employees.localhost.com, or employees.* where * is the SERVER_NAME of this request
void	setImage(java.lang.String pathToImage) Sets the portal context relative path to the image associated with this space
void	setOwner(java.lang.String owner) Sets the owner on this environment
void	setSecurityConstraint(java.lang.String constraint) Set the security constraint on this space
void	setShortTitle(java.lang.String shortTitle) Set the short title of space
void	setShortTitle(java.lang.String shortTitle, java.util.Locale locale) Set the short title of space for the given locale
void	setTheme(java.lang.String themeName) Sets the theme name to be associated with this space All pages in this space will inherit the theme (unless the theme is overriden on the specific page or folder)
void	setTitle(java.lang.String title) Set the title of space
void	setTitle(java.lang.String title, java.util.Locale locale) Set the title of space for the given locale

Field Detail

META_SPACE_OWNER

static final java.lang.String META_SPACE_OWNER

See Also:

Constant Field Values

META_SPACE_DOMAIN_PATH

static final java.lang.String META_SPACE_DOMAIN_PATH

See Also:

Constant Field Values

META_SPACE_IMAGE

static final java.lang.String META_SPACE_IMAGE

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Retrieve the name of the space

Returns:

the name of the space

getTitle

java.lang.String getTitle(java.util.Locale locale)

Retrieve the localized title of the space for the requested locale

Returns:

the localized title

getTitle

java.lang.String getTitle()

Retrieve the unlocalized title of the space

Returns:

the unlocalized title

getShortTitle

java.lang.String getShortTitle(java.util.Locale locale)

Retrieve the localized short title of the space for the requested locale

Returns:

the localized title

getShortTitle

java.lang.String getShortTitle()

Retrieve the unlocalized short title of the space

Returns:

the unlocalized title

setTitle

void setTitle(java.lang.String title,
              java.util.Locale locale)

Set the title of space for the given locale

Parameters:

locale -

title -

setTitle

void setTitle(java.lang.String title)

Set the title of space

Parameters:

title -

setShortTitle

void setShortTitle(java.lang.String shortTitle,
                   java.util.Locale locale)

Set the short title of space for the given locale

Parameters:

locale -

title -

setShortTitle

void setShortTitle(java.lang.String shortTitle)

Set the short title of space

Parameters:

title -

getPath

java.lang.String getPath()

Retrieve the path of the space, which can be implementation specific

Returns:

the path to where the space is stored

getDescription

java.lang.String getDescription(java.util.Locale locale)

Retrieve the description of this space

Parameters:

locale - the locale of the string

Returns:

getDescription

java.lang.String getDescription()

Retrieve the description of this space

Returns:

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Sets the description on this space

Parameters:

description -

locale - the locale of the string

setDescription

void setDescription(java.lang.String description)

Sets the description on this space

Parameters:

description -

getOwner

java.lang.String getOwner()

Retrieves the owner, a portal user name, for this space

Returns:

the name of the space owner

setOwner

void setOwner(java.lang.String owner)

Sets the owner on this environment

Parameters:

owner -

getImage

java.lang.String getImage()

Retrieves the image associated with this space

Returns:

a portal context relative path to the image

setImage

void setImage(java.lang.String pathToImage)

Sets the portal context relative path to the image associated with this space

Parameters:

pathToImage - the portal context relative path to the image

getDashboard

java.lang.String getDashboard()

Retrieves the default dashboard for this space. There can only be one dashboard per space

Returns:

a dashboard name, the page which represents the dashboard

setDashboard

void setDashboard(java.lang.String dashboard)

Sets the dashboard for this space. Dashboards are really just pages

Parameters:

page -

getDomainPath

java.lang.String getDomainPath()

Retrieves the domain path associated with this space For example, employees.localhost.com, or employees.* where * is the SERVER_NAME of this request

Returns:

the domain path string

setDomainPath

void setDomainPath(java.lang.String domain)

Sets the domain path associated with this space For example, employees.localhost.com, or employees.* where * is the SERVER_NAME of this request

Parameters:

domain - the domain path string

getTheme

java.lang.String getTheme()

Retrieves the theme name for this space

Returns:

the theme name

setTheme

void setTheme(java.lang.String themeName)

Sets the theme name to be associated with this space All pages in this space will inherit the theme (unless the theme is overriden on the specific page or folder)

Parameters:

themeName - the name of the theme

getSecuredRoles

java.util.List<java.lang.String> getSecuredRoles()

Retrieve the list of secured roles constraining access to this space

Returns:

the list of role name strings

addSecuredRole

void addSecuredRole(java.lang.String role)

Add a role to the list of required roles to view this space

Parameters:

role -

removeSecuredRole

void removeSecuredRole(java.lang.String role)

Remove a role from the list of required roles to view this space

Parameters:

role -

getSecuredGroup

java.util.List<java.lang.String> getSecuredGroup()

Retrieve the list of secured groups constraining access to this space

Returns:

the list of group name strings

addSecuredGroup

void addSecuredGroup(java.lang.String group)

Add a group to the list of required group to view this space

Parameters:

group -

removeSecuredGroup

void removeSecuredGroup(java.lang.String group)

Remove a group from the list of required roles to view this space

Parameters:

group -

getSecuredUsers

java.util.List<java.lang.String> getSecuredUsers()

Retrieve the list of secured users constraining access to this space

Returns:

the list of users name strings

addSecuredUser

void addSecuredUser(java.lang.String user)

Add a username to the list of users who can view this page

Parameters:

user - the name of user

removeSecuredUser

void removeSecuredUser(java.lang.String user)

Remove a user from the list of required users to view this space

Parameters:

user - the name of user

getSecurityConstraint

java.lang.String getSecurityConstraint()

Get the security constraint on this space

setSecurityConstraint

void setSecurityConstraint(java.lang.String constraint)

Set the security constraint on this space