org.gatein.mop.api.workspace
Interface Workspace

All Superinterfaces:

CustomizationContext, WorkspaceCustomizationContext, WorkspaceObject

public interface Workspace
extends WorkspaceObject, WorkspaceCustomizationContext

The workspace.

Version:

$Revision$

Author:

Julien Viet

Field Summary

Fields inherited from interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext

TYPE

Method Summary

<S extends Site> S	addSite(ObjectType<S> siteType, String name) Creates a new site.
<O extends WorkspaceObject> O	getObject(ObjectType<O> type, String id) Returns a specified object or null if it cannot be found.
Site	getSharedSite() Returns the default share site.
<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.workspace.WorkspaceCustomizationContext

customize, customize, getCustomization

Methods inherited from interface org.gatein.mop.api.content.CustomizationContext

contains, getContextId, getContextType

Method Detail

getSharedSite

Site getSharedSite()

Returns the default share site.

Returns:

the default shared site

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

getObject

<O extends WorkspaceObject> O getObject(ObjectType<O> type,
                                        String id)

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

Type Parameters:

O - the object type parameter

Parameters:

type - the object type

id - the object id

Returns:

the object