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.window;
21  
22  import org.apache.pluto.om.Model;
23  import org.apache.pluto.om.common.ObjectID;
24  
25  
26  /***
27   * <P>
28   * The <CODE>PortletWindowSet</CODE> interface defines a set which
29   * can hold <CODE>PortletWindow</CODE> objects.
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  public interface PortletWindowList extends Model {
38  
39     
40      /***
41       * Returns all portlet windows as iterator
42       * The return value cannot be NULL.
43       * 
44       * @return An iterator containing <CODE>PortletWindow</CODE> objects
45       */
46      public java.util.Iterator iterator();
47  
48      /***
49       * Returns the portlet window object of the given id.
50       * The return value may be NULL.
51       * 
52       * @return the portlet window object
53       **/ 
54      public PortletWindow get(ObjectID id);
55  
56  }