View Javadoc

1   /*
2    * Copyright 2003,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  /* 
17  
18   */
19  
20  package org.apache.pluto.om.entity;
21  
22  import org.apache.pluto.om.common.ObjectID;
23  import org.apache.pluto.om.portlet.PortletApplicationDefinition;
24  
25  /***
26   * <P>
27   * The <CODE>PortletApplicationEntity</CODE> interface represents an instance of the
28   * application/context describing the portlets. The application instance may only
29   * contain one instance of each portlet of the corresponding application description.
30   * </P>
31   * <P>
32   * This interface defines the model as known from the MVC pattern.
33   * Its purpose is to provide read access to the data stored in the model.
34   * </P>
35   * 
36  
37   */
38  public interface PortletApplicationEntity extends org.apache.pluto.om.Model
39  {
40  
41  
42      /***
43       * Returns the identifier of this portlet application instance as object id.
44       * The return value cannot be NULL.
45       * 
46       * @return the object identifier
47       */
48      public ObjectID getId();
49  
50      /***
51       * Returns all portlet entities contained in the application entity.
52       * 
53       * @return a collection of <CODE>PortletEntity</CODE> objects
54       */
55      public PortletEntityList getPortletEntityList();
56  
57      /***
58       * Returns the portlet application definition.
59       * The return value cannot be NULL.
60       * 
61       * @return the portlet application definition
62       */
63      public PortletApplicationDefinition getPortletApplicationDefinition();
64  
65  }