org.gatein.mop.api.workspace
Interface Site

All Superinterfaces:

CustomizationContext, WorkspaceCustomizationContext, WorkspaceObject

public interface Site
extends WorkspaceObject, WorkspaceCustomizationContext

A site is a collection of pages and navigations.

Version:

$Revision$

Author:

Julien Viet

Field Summary

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

TYPE

Method Summary

void	destroy() Destroy the site.
String	getName() Returns the site name.
String	getObjectId() Returns the site id.
ObjectType<? extends Site>	getObjectType() Returns a type that extends the site.
Navigation	getRootNavigation() Returns the site root navigation.
Page	getRootPage() Returns the site root page.
Workspace	getWorkspace() Returns the site workspace.

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

getAttributes

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

getObjectId

String getObjectId()

Returns the site id.

Specified by:

getObjectId in interface WorkspaceObject

Returns:

the site id

getName

String getName()

Returns the site name.

Returns:

the site name

getObjectType

ObjectType<? extends Site> getObjectType()

Returns a type that extends the site.

Specified by:

getObjectType in interface WorkspaceObject

Returns:

the objec type

getRootNavigation

Navigation getRootNavigation()

Returns the site root navigation.

Returns:

the site navigation

getRootPage

Page getRootPage()

Returns the site root page.

Returns:

the site root page

getWorkspace

Workspace getWorkspace()

Returns the site workspace.

Returns:

the site workspace

destroy

void destroy()

Destroy the site.