SiteNeighbourhoodService.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/portal/trunk/portal-api/api/src/java/org/sakaiproject/portal/api/SiteNeighbourhoodService.java $
 * $Id: SiteNeighbourhoodService.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 The Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.opensource.org/licenses/ECL-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **********************************************************************************/

package org.sakaiproject.portal.api;

import java.util.List;

import javax.servlet.http.HttpServletRequest;

import org.sakaiproject.site.api.Site;
import org.sakaiproject.tool.api.Session;

/**
 * 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
 *
 */
public interface SiteNeighbourhoodService
{

	/**
	 * Get a list of sites at the current node as defined by the request
	 * @param request
	 * @param session
	 * @param includeMyWorksite
	 * @return
	 */
	List<Site> getSitesAtNode(HttpServletRequest request, Session session, boolean includeMyWorksite);
	
	/**
	 * Convert an ID that is normally displayed in the URL into something more readable.
	 * @param siteId The ID to convert.
	 * @param content The context that this site is presented in.
	 * @return 
	 */
	String lookupSiteAlias(String siteId, String content);
	
	
	/**
	 * Attempt to convert an alias back into a site reference.
	 * @param alias
	 * @return <code>null</code> if we couldn't find an reference that this maps to.
	 */
	String parseSiteAlias(String alias);

}