org.nuxeo.core.resources.model
Interface IResourceTreeRoot

All Superinterfaces:

IContainer

All Known Implementing Classes:

ResourceTreeRoot

public interface IResourceTreeRoot
extends IContainer

The root of the Apogee resource tree. The root is a site container. It cannot contains other resources than sites. The root is managed by the IResourceManager.

Author:

Bogdan Stefanescu

See Also:

IResourceManager.getRoot()

Field Summary

Fields inherited from interface org.nuxeo.core.resources.model.IContainer

EMPTY_CHILDREN

Method Summary

void	addSite(ISite site) Add this site to the container
ISite	findContainerSite(java.lang.String uri) Find the site containing that may contains a resource with the given URI If more than one sites are found the site with the longest URI is returned
ISite	findSite(java.lang.String uri) Find a defined site given the site URI
ISite[]	findSites() Find all defined sites in this container
ISite	getSite(java.lang.String uri) Get a handle for a site having the given URI This is a handle operation so the site handle is returned even if the site is not existing
void	removeSite(ISite site) Remove the site from the container

Methods inherited from interface org.nuxeo.core.resources.model.IContainer

children, findChild

Method Detail

findSites

ISite[] findSites()

Find all defined sites in this container

Returns:

the defined sites. If the container is empty returns an empty list

findSite

ISite findSite(java.lang.String uri)

Find a defined site given the site URI

Parameters:

uri - the site URI

Returns:

the site or null if no suvh site exists

findContainerSite

ISite findContainerSite(java.lang.String uri)

Find the site containing that may contains a resource with the given URI
If more than one sites are found the site with the longest URI is returned

Parameters:

uri - the resource URI

Returns:

the site containing this resource

addSite

void addSite(ISite site)

Add this site to the container

Parameters:

site -

removeSite

void removeSite(ISite site)

Remove the site from the container

Parameters:

site -

getSite

ISite getSite(java.lang.String uri)

Get a handle for a site having the given URI This is a handle operation so the site handle is returned even if the site is not existing

Parameters:

uri - the site URI

Returns:

the site handle. Cannot be null