org.apache.jetspeed.spaces
Interface Environment

public interface Environment

Container for spaces

Version:

$Id: Environment.java 903904 2010-01-27 23:30:43Z taylor $

Author:

David Sean Taylor

Field Summary

static java.lang.String

META_ENV_OWNER

Method Summary

java.lang.String	getDescription() Retrieve the description of this environment
java.lang.String	getDescription(java.util.Locale locale) Retrieve the description of this environment
java.lang.String	getName() Retrieve the name of the environment
java.lang.String	getOwner() Retrieves the owner, a portal user name, for this environment
java.lang.String	getPath() Retrieve the path of the environment, which can be implementation specific
java.lang.String	getTitle() Retrieve unlocalized title of the environment
java.lang.String	getTitle(java.util.Locale locale) Retrieve the localized title of the environment for the requested locale
void	setDescription(java.lang.String description) Sets the description on this environment
void	setDescription(java.lang.String description, java.util.Locale locale) Sets the description on this environment
void	setOwner(java.lang.String owner) Sets the owner on this environment
void	setTitle(java.lang.String title) Set the title of environment
void	setTitle(java.lang.String title, java.util.Locale locale) Set the title of environment for the given locale

Field Detail

META_ENV_OWNER

static final java.lang.String META_ENV_OWNER

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Retrieve the name of the environment

Returns:

the name of the environment

getTitle

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

Retrieve the localized title of the environment for the requested locale

Parameters:

locale - the locale of the string

Returns:

the localized title

getTitle

java.lang.String getTitle()

Retrieve unlocalized title of the environment

Returns:

the unlocalized title

setTitle

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

Set the title of environment for the given locale

Parameters:

locale - the locale of the string

title -

setTitle

void setTitle(java.lang.String title)

Set the title of environment

Parameters:

title -

getPath

java.lang.String getPath()

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

Returns:

the path to where the environment is stored

getDescription

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

Retrieve the description of this environment

Parameters:

locale - the locale of the string

Returns:

setDescription

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

Sets the description on this environment

Parameters:

description -

locale - the locale of the string

getDescription

java.lang.String getDescription()

Retrieve the description of this environment

Returns:

setDescription

void setDescription(java.lang.String description)

Sets the description on this environment

Parameters:

description -

getOwner

java.lang.String getOwner()

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

Returns:

the name of the environment owner

setOwner

void setOwner(java.lang.String owner)

Sets the owner on this environment

Parameters:

owner -