01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/portal/tags/sakai_2-4-1/portal-api/api/src/java/org/sakaiproject/portal/api/PortletApplicationDescriptor.java $
03: * $Id: PortletApplicationDescriptor.java 29143 2007-04-19 01:10:38Z ajpoland@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.portal.api;
21:
22: import java.util.Iterator;
23:
24: /**
25: * Describes a Portlet application when it is loaded into the Web Container
26: *
27: * @author ieb
28: * @since Sakai 2.4
29: * @version $Rev: 29143 $
30: *
31: *
32: */
33: public interface PortletApplicationDescriptor {
34:
35: /**
36: * The name of the portlet
37: *
38: * @return
39: */
40: String getApplicationName();
41:
42: /**
43: * The name of the context (servlet context)
44: *
45: * @return
46: */
47: String getApplicationContext();
48:
49: /**
50: * The application ID
51: *
52: * @return
53: */
54: String getApplicationId();
55:
56: /**
57: * An interator of portlet descriptions
58: *
59: * @return
60: */
61: Iterator<PortletDescriptor> getPortlets();
62:
63: }
|