SiteNeighbourhoodService (sakai-portal-api 22.1 API)

```
public interface SiteNeighbourhoodService
```
The SiteNeighbourhoodService provides a list of sites in the neighbourhood of the current context. This might be all sites, or it might be just the children, siblings and drect parents of a site. It is returned as a flat list.

Author:

ieb

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<org.sakaiproject.site.api.Site>`	`getSitesAtNode(javax.servlet.http.HttpServletRequest request, org.sakaiproject.tool.api.Session session, boolean includeMyWorksite)`	Get a list of sites at the current node as defined by the request
`String`	`lookupSiteAlias(String siteId, String content)`	Convert an ID that is normally displayed in the URL into something more readable.
`String`	`parseSiteAlias(String alias)`	Attempt to convert an alias back into a site reference.

- Method Detail
  - getSitesAtNode
```
List<org.sakaiproject.site.api.Site> getSitesAtNode(javax.servlet.http.HttpServletRequest request,
                                                    org.sakaiproject.tool.api.Session session,
                                                    boolean includeMyWorksite)
```
    Get a list of sites at the current node as defined by the request
    
    Parameters:
    
    request -
    
    session -
    
    includeMyWorksite -
    
    Returns:
  - lookupSiteAlias
```
String lookupSiteAlias(String siteId,
                       String content)
```
    Convert an ID that is normally displayed in the URL into something more readable.
    
    Parameters:
    
    siteId - The ID to convert.
    
    content - The context that this site is presented in.
    
    Returns:
  - parseSiteAlias
```
String parseSiteAlias(String alias)
```
    Attempt to convert an alias back into a site reference.
    
    Parameters:
    
    alias -
    
    Returns:
    
    null if we couldn't find an reference that this maps to.