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

Fields

Modifier and Type	Field and Description
static String	META_ENV_OWNER

Method Summary

Methods

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

Field Detail

META_ENV_OWNER

static final String META_ENV_OWNER

See Also:

Constant Field Values

Method Detail

getName

String getName()

Retrieve the name of the environment

Returns:

the name of the environment

getTitle

String getTitle(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

String getTitle()

Retrieve unlocalized title of the environment

Returns:

the unlocalized title

setTitle

void setTitle(String title,
            Locale locale)

Set the title of environment for the given locale

Parameters:

locale - the locale of the string

title -

setTitle

void setTitle(String title)

Set the title of environment

Parameters:

title -

getPath

String getPath()

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

Returns:

the path to where the environment is stored

getDescription

String getDescription(Locale locale)

Retrieve the description of this environment

Parameters:

locale - the locale of the string

Returns:

setDescription

void setDescription(String description,
                  Locale locale)

Sets the description on this environment

Parameters:

description -

locale - the locale of the string

getDescription

String getDescription()

Retrieve the description of this environment

Returns:

setDescription

void setDescription(String description)

Sets the description on this environment

Parameters:

description -

getOwner

String getOwner()

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

Returns:

the name of the environment owner

setOwner

void setOwner(String owner)

Sets the owner on this environment

Parameters:

owner -