1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.pluto.om.portlet;
18
19 import org.apache.pluto.om.common.ObjectID;
20 import org.apache.pluto.om.servlet.WebApplicationDefinition;
21
22 /***
23 * <P>
24 * This interface provides access to a portlet application and its attributes.
25 * A portlet application is defined in the portlet.xml of a portlet application
26 * archive file.<br>
27 * Additionally, this interface allows to retrieve containing elements such
28 * as portlets.
29 * </P>
30 * <P>
31 * This interface defines the model as known from the MVC pattern.
32 * Its purpose is to provide read access to the data stored in the model.
33 * </P>
34 *
35 */
36 public interface PortletApplicationDefinition extends org.apache.pluto.om.Model
37 {
38
39
40 /***
41 * Returns the identifier of this portlet as object id.
42 * The return value cannot be NULL.
43 *
44 * @return the object identifier
45 */
46 public ObjectID getId();
47
48 /***
49 * Returns the version of this portlet application.
50 * The return value may be NULL.
51 *
52 * @return the version
53 */
54 public String getVersion();
55
56
57 /***
58 * Returns all portlets contained in this portlet application.
59 * The return value cannot be NULL.
60 *
61 * @return a collection containing PortletDefinition objects
62 */
63 public PortletDefinitionList getPortletDefinitionList();
64
65 /***
66 * Returns the corresponding web application to this portlet application.
67 * The return value cannot be NULL.
68 *
69 * @return a web application
70 */
71 public WebApplicationDefinition getWebApplicationDefinition();
72
73 }