Space (Jetspeed-2 Core API 2.3.1 API)

```
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

Fields
Modifier and Type Field and Description

static String META_SPACE_DOMAIN_PATH

static String META_SPACE_IMAGE

static String META_SPACE_OWNER

Fields
Modifier and Type	Field and Description
`static String`	`META_SPACE_DOMAIN_PATH`
`static String`	`META_SPACE_IMAGE`
`static String`	`META_SPACE_OWNER`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addSecuredGroup(String group)` Add a group to the list of required group to view this space
`void`	`addSecuredRole(String role)` Add a role to the list of required roles to view this space
`void`	`addSecuredUser(String user)` Add a username to the list of users who can view this page
`String`	`getDashboard()` Retrieves the default dashboard for this space.
`String`	`getDescription()` Retrieve the description of this space
`String`	`getDescription(Locale locale)` Retrieve the description of this space
`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
`String`	`getImage()` Retrieves the image associated with this space
`String`	`getName()` Retrieve the name of the space
`String`	`getOwner()` Retrieves the owner, a portal user name, for this space
`String`	`getPath()` Retrieve the path of the space, which can be implementation specific
`List<String>`	`getSecuredGroup()` Retrieve the list of secured groups constraining access to this space
`List<String>`	`getSecuredRoles()` Retrieve the list of secured roles constraining access to this space
`List<String>`	`getSecuredUsers()` Retrieve the list of secured users constraining access to this space
`String`	`getSecurityConstraint()` Get the security constraint on this space
`String`	`getShortTitle()` Retrieve the unlocalized short title of the space
`String`	`getShortTitle(Locale locale)` Retrieve the localized short title of the space for the requested locale
`String`	`getTheme()` Retrieves the theme name for this space
`String`	`getTitle()` Retrieve the unlocalized title of the space
`String`	`getTitle(Locale locale)` Retrieve the localized title of the space for the requested locale
`void`	`removeSecuredGroup(String group)` Remove a group from the list of required roles to view this space
`void`	`removeSecuredRole(String role)` Remove a role from the list of required roles to view this space
`void`	`removeSecuredUser(String user)` Remove a user from the list of required users to view this space
`void`	`setDashboard(String dashboard)` Sets the dashboard for this space.
`void`	`setDescription(String description)` Sets the description on this space
`void`	`setDescription(String description, Locale locale)` Sets the description on this space
`void`	`setDomainPath(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(String pathToImage)` Sets the portal context relative path to the image associated with this space
`void`	`setOwner(String owner)` Sets the owner on this environment
`void`	`setSecurityConstraint(String constraint)` Set the security constraint on this space
`void`	`setShortTitle(String shortTitle)` Set the short title of space
`void`	`setShortTitle(String shortTitle, Locale locale)` Set the short title of space for the given locale
`void`	`setTheme(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(String title)` Set the title of space
`void`	`setTitle(String title, Locale locale)` Set the title of space for the given locale

- Field Detail
  - META_SPACE_OWNER
```
static final String META_SPACE_OWNER
```
    See Also:
    Constant Field Values
  - META_SPACE_DOMAIN_PATH
```
static final String META_SPACE_DOMAIN_PATH
```
    See Also:
    Constant Field Values
  - META_SPACE_IMAGE
```
static final String META_SPACE_IMAGE
```
    See Also:
    Constant Field Values
- Method Detail
  - getName
```
String getName()
```
    Retrieve the name of the space
    
    Returns:
    the name of the space
  - getTitle
```
String getTitle(Locale locale)
```
    Retrieve the localized title of the space for the requested locale
    
    Returns:
    the localized title
  - getTitle
```
String getTitle()
```
    Retrieve the unlocalized title of the space
    
    Returns:
    the unlocalized title
  - getShortTitle
```
String getShortTitle(Locale locale)
```
    Retrieve the localized short title of the space for the requested locale
    
    Returns:
    the localized title
  - getShortTitle
```
String getShortTitle()
```
    Retrieve the unlocalized short title of the space
    
    Returns:
    the unlocalized title
  - setTitle
```
void setTitle(String title,
            Locale locale)
```
    Set the title of space for the given locale
    
    Parameters:
    locale -
    title -
  - setTitle
```
void setTitle(String title)
```
    Set the title of space
    
    Parameters:
    title -
  - setShortTitle
```
void setShortTitle(String shortTitle,
                 Locale locale)
```
    Set the short title of space for the given locale
    
    Parameters:
    locale -
    title -
  - setShortTitle
```
void setShortTitle(String shortTitle)
```
    Set the short title of space
    
    Parameters:
    title -
  - getPath
```
String getPath()
```
    Retrieve the path of the space, which can be implementation specific
    
    Returns:
    the path to where the space is stored
  - getDescription
```
String getDescription(Locale locale)
```
    Retrieve the description of this space
    
    Parameters:
    locale - the locale of the string
    
    Returns:
  - getDescription
```
String getDescription()
```
    Retrieve the description of this space
    
    Returns:
  - setDescription
```
void setDescription(String description,
                  Locale locale)
```
    Sets the description on this space
    
    Parameters:
    description -
    locale - the locale of the string
  - setDescription
```
void setDescription(String description)
```
    Sets the description on this space
    
    Parameters:
    description -
  - getOwner
```
String getOwner()
```
    Retrieves the owner, a portal user name, for this space
    
    Returns:
    the name of the space owner
  - setOwner
```
void setOwner(String owner)
```
    Sets the owner on this environment
    
    Parameters:
    owner -
  - getImage
```
String getImage()
```
    Retrieves the image associated with this space
    
    Returns:
    a portal context relative path to the image
  - setImage
```
void setImage(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
```
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(String dashboard)
```
    Sets the dashboard for this space. Dashboards are really just pages
    
    Parameters:
    page -
  - getDomainPath
```
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(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
```
String getTheme()
```
    Retrieves the theme name for this space
    
    Returns:
    the theme name
  - setTheme
```
void setTheme(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
```
List<String> getSecuredRoles()
```
    Retrieve the list of secured roles constraining access to this space
    
    Returns:
    the list of role name strings
  - addSecuredRole
```
void addSecuredRole(String role)
```
    Add a role to the list of required roles to view this space
    
    Parameters:
    role -
  - removeSecuredRole
```
void removeSecuredRole(String role)
```
    Remove a role from the list of required roles to view this space
    
    Parameters:
    role -
  - getSecuredGroup
```
List<String> getSecuredGroup()
```
    Retrieve the list of secured groups constraining access to this space
    
    Returns:
    the list of group name strings
  - addSecuredGroup
```
void addSecuredGroup(String group)
```
    Add a group to the list of required group to view this space
    
    Parameters:
    group -
  - removeSecuredGroup
```
void removeSecuredGroup(String group)
```
    Remove a group from the list of required roles to view this space
    
    Parameters:
    group -
  - getSecuredUsers
```
List<String> getSecuredUsers()
```
    Retrieve the list of secured users constraining access to this space
    
    Returns:
    the list of users name strings
  - addSecuredUser
```
void addSecuredUser(String user)
```
    Add a username to the list of users who can view this page
    
    Parameters:
    user - the name of user
  - removeSecuredUser
```
void removeSecuredUser(String user)
```
    Remove a user from the list of required users to view this space
    
    Parameters:
    user - the name of user
  - getSecurityConstraint
```
String getSecurityConstraint()
```
    Get the security constraint on this space
  - setSecurityConstraint
```
void setSecurityConstraint(String constraint)
```
    Set the security constraint on this space

Interface Space

Field Summary

Method Summary

Field Detail

META_SPACE_OWNER

META_SPACE_DOMAIN_PATH

META_SPACE_IMAGE

Method Detail

getName

getTitle

getTitle

getShortTitle

getShortTitle

setTitle

setTitle

setShortTitle

setShortTitle

getPath

getDescription

getDescription

setDescription

setDescription

getOwner

setOwner

getImage

setImage

getDashboard

setDashboard

getDomainPath

setDomainPath

getTheme

setTheme

getSecuredRoles

addSecuredRole

removeSecuredRole

getSecuredGroup

addSecuredGroup

removeSecuredGroup

getSecuredUsers

addSecuredUser

removeSecuredUser

getSecurityConstraint

setSecurityConstraint