org.nuxeo.core.resources.model
Interface ISiteContainer

All Superinterfaces:
IContainer

public interface ISiteContainer
extends IContainer

A container of ISite resources

Author:
Bogdan Stefanescu

Field Summary
 
Fields inherited from interface org.nuxeo.core.resources.model.IContainer
EMPTY_CHILDREN
 
Method Summary
 void addSite(ISite site)
          Add a new site to this container
 ISite findOwnerSite(java.lang.String uri)
          Find the existing site owning the given uri
 ISite findSite(java.lang.String uri)
          Find existing site having the URI euqls to the given one
 ISite[] findSites()
          Return the existing sites owned by this manager
 ISite getSite(java.lang.String uri)
          Get the site having the given uri.
 void removeSite(java.lang.String uri)
          Remove the site with the given URI from the container
 
Methods inherited from interface org.nuxeo.core.resources.model.IContainer
children, findChild
 

Method Detail

addSite

void addSite(ISite site)
Add a new site to this container

Parameters:
site - the site to add

removeSite

void removeSite(java.lang.String uri)
Remove the site with the given URI from the container

Parameters:
uri - the site URI to remove

getSite

ISite getSite(java.lang.String uri)
Get the site having the given uri. This is handle operation so it return a resource even if the underlying object is not existing

Parameters:
uri - the site uri
Returns:
the site. Cannot be null even if the site was not yet created

findSite

ISite findSite(java.lang.String uri)
Find existing site having the URI euqls to the given one

Parameters:
uri - the uri
Returns:
the site or null if none

findOwnerSite

ISite findOwnerSite(java.lang.String uri)
Find the existing site owning the given uri

Parameters:
uri - the uri
Returns:
the owner site or null if none

findSites

ISite[] findSites()
Return the existing sites owned by this manager

Returns:
the sites array