PortletEntityCtrl


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.portlet.PortletDefinition;
23  
24  /**
25   * <P>
26   * The <CODE>PortletEntityCtrl</CODE> interface represents a single portlet occurance,
27   * that can be shown on a single page or on multiple pages.
28   * </P>
29   * <P>
30   * This interface defines the controller as known from the MVC pattern.
31   * Its purpose is to provide write access to the data stored in the model.
32   * </P>
33   * 
34  
35   */
36  public interface PortletEntityCtrl extends org.apache.pluto.om.Controller
37  {
38  
39  
40      /**
41       * binds an identifier to this portlet instance
42       * 
43       * @param id the new identifier
44       */
45      public void setId(String   id);
46  
47      /**
48       * Sets the portlet definition for this entity.
49       * This value should not be null
50       * 
51       * @param portletDefinition the portlet description
52       */
53      public void setPortletDefinition(PortletDefinition portletDefinition);
54  
55      /**
56       * Stores the object persistently
57       * 
58       * @exception java.io.IOException
59       *                   in case of trouble fulfilling the request
60       */
61      public void store() throws java.io.IOException  ;
62  
63      /**
64       * Reset all changes made until the last <code>store</code>
65       * call in the persistent store.
66       * 
67       * @exception java.io.IOException
68       *                   in case of trouble fulfilling the request
69       */
70      public void reset() throws java.io.IOException  ;
71  
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags