/**********************************************************************************
* $URL: https://source.sakaiproject.org/svn/portal/trunk/portal-api/api/src/java/org/sakaiproject/portal/api/PortletApplicationDescriptor.java $
* $Id: PortletApplicationDescriptor.java 105079 2012-02-24 23:08:11Z ottenhoff@longsight.com $
***********************************************************************************
*
* Copyright (c) 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.Iterator;
/**
* Describes a Portlet application when it is loaded into the Web Container
*
* @author ieb
* @since Sakai 2.4
* @version $Rev: 105079 $
*
*
*/
public interface PortletApplicationDescriptor
{
/**
* The name of the portlet
*
* @return
*/
String getApplicationName();
/**
* The name of the context (servlet context)
*
* @return
*/
String getApplicationContext();
/**
* The application ID
*
* @return
*/
String getApplicationId();
/**
* An interator of portlet descriptions
*
* @return
*/
Iterator<PortletDescriptor> getPortlets();
}