org.gatein.mop.api.workspace

Interface Workspace

All Superinterfaces:

Adaptable, WorkspaceObject

public interface Workspace
extends WorkspaceObject

The workspace.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Methods

Modifier and Type	Method and Description
<S extends Site> S	addSite(ObjectType<S> siteType, String name) Creates a new site.
WorkspaceCustomizationContext	getCustomizationContext() Returns the customization context of this object;
<S extends Site> S	getSite(ObjectType<S> siteType, String siteName) Returns a specified site or null if it cannot be found.
Collection<Site>	getSites() Returns all the sites.
<S extends Site> Collection<S>	getSites(ObjectType<S> siteType) Returns the sites of a given type.

Methods inherited from interface org.gatein.mop.api.workspace.WorkspaceObject

getAttributes, getObjectId, getObjectType

Methods inherited from interface org.gatein.mop.api.Adaptable

adapt, isAdapted, removeAdapter

Method Detail

getSite

<S extends Site> S getSite(ObjectType<S> siteType,
                         String siteName)

Returns a specified site or null if it cannot be found.

Parameters:

siteType - the site type

siteName - the site name

Returns:

the site

getSites

<S extends Site> Collection<S> getSites(ObjectType<S> siteType)

Returns the sites of a given type.

Parameters:

siteType - the site type

Returns:

the sites

getSites

Collection<Site> getSites()

Returns all the sites.

Returns:

the sites

addSite

<S extends Site> S addSite(ObjectType<S> siteType,
                         String name)

Creates a new site.

Parameters:

siteType - the site type

name - the site name

Returns:

the new site

getCustomizationContext

WorkspaceCustomizationContext getCustomizationContext()

Returns the customization context of this object;

Returns:

the customization context