KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > om > entity > PortletEntityList


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
24 /**
25  * <P>
26  * This interface provides access to a set of <CODE>PortletEntity</CODE> objects.
27  * </P>
28  * <P>
29  * This interface defines the model as known from the MVC pattern.
30  * Its purpose is to provide read access to the data stored in the model.
31  * </P>
32  *
33  */
34
35 public interface PortletEntityList extends org.apache.pluto.om.Model
36 {
37
38
39     /**
40      * Returns all portlet entities as iterator.
41      * The return value cannot be NULL.
42      *
43      * @return An iterator containing <CODE>PortletEntity</CODE> objects
44      */
45     public java.util.Iterator JavaDoc iterator();
46
47     /**
48      * Returns the portlet entity object of the given id.
49      * The return value may be NULL.
50      *
51      * @return the portlet entity object
52      */
53     public PortletEntity get(ObjectID id);
54
55 }
56
Popular Tags