org.gatein.mop.api.workspace
Interface Navigation

All Superinterfaces:

Templatized, TemplatizedObject, WorkspaceObject

public interface Navigation
extends TemplatizedObject

Version:

$Revision$

Author:

Julien Viet

Method Summary

Navigation	addChild(String name) Adds a child navigation
void	destroy() Destroys this navigation.
Navigation	getChild(String name) Returns a specified navigation.
Collection<? extends Navigation>	getChildren() Returns the child navigations.
Link	getLink() Returns the current link related to this navitation object.
String	getName() Returns the navigation name.
ObjectType<? extends Navigation>	getObjectType() Extends the object type to navigation.
Navigation	getParent() Return the navigation parent or null if it is a root.
Site	getSite() Returns the site this navigation belongs to
<L extends Link> L	linkTo(ObjectType<L> linkType) Link the navigation to a specifed type and returns the corresponding link subclass that allows the configuration of the link.

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

getAttributes, getObjectId

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

getTemplate, setTemplate

Method Detail

getName

String getName()

Returns the navigation name.

Returns:

the navigation name

getObjectType

ObjectType<? extends Navigation> getObjectType()

Extends the object type to navigation.

Specified by:

getObjectType in interface WorkspaceObject

Returns:

the object type

getSite

Site getSite()

Returns the site this navigation belongs to

Returns:

the site

getParent

Navigation getParent()

Return the navigation parent or null if it is a root.

Returns:

the navigation parent

getChildren

Collection<? extends Navigation> getChildren()

Returns the child navigations.

Returns:

the child navigations

getChild

Navigation getChild(String name)

Returns a specified navigation.

Parameters:

name - the navigation name

Returns:

a child navigation

addChild

Navigation addChild(String name)
                    throws NullPointerException,
                           IllegalArgumentException

Adds a child navigation

Parameters:

name - the child name

Returns:

the child navigation

Throws:

NullPointerException - when a null name is provided

IllegalArgumentException - when an illegal name is provided

destroy

void destroy()

Destroys this navigation.

getLink

Link getLink()

Returns the current link related to this navitation object.

Returns:

the link

linkTo

<L extends Link> L linkTo(ObjectType<L> linkType)

Link the navigation to a specifed type and returns the corresponding link subclass that allows the configuration of the link.

Type Parameters:

L - the link type parameter

Parameters:

linkType - the link type

Returns:

the link object