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.entity.PortletEntity;
23  
24  /***
25   * <P>
26   * The <CODE>PortletWindow</CODE> interface represents a single window
27   * of an portlet instance as it can be shown only once on a single page. 
28   * Adding the same portlet e.g. twice on a page results in two different windows.
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   **/
37  public interface PortletWindowCtrl extends org.apache.pluto.om.Controller {
38  
39      
40      /***
41       * binds an identifier to this portlet window
42       * 
43       * @param id the new identifier
44       */
45      public void setId(String id);
46  
47      /***
48       * binds a portlet instance to this portlet window
49       * 
50       * @param portletEntity a portlet entity object
51       **/
52      public void setPortletEntity(PortletEntity portletEntity);
53  
54  }