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.portlet;
21  
22  import org.apache.pluto.om.common.DescriptionSet;
23  import org.apache.pluto.om.common.DisplayNameSet;
24  
25  /***
26   * <P>
27   * The <CODE>PortletDefinitionCtrl</CODE> interface ...
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 PortletDefinitionCtrl extends org.apache.pluto.om.Controller
37  {
38  
39  
40      /***
41       * Binds an identifier to this portlet
42       * 
43       * @param id the new identifier
44       */
45      public void setId(String id);
46  
47      /***
48       * Sets the new class name
49       * 
50       * @param className the new class name
51       */
52      public void setClassName(String className);
53  
54      /***
55       * Binds an administrative name
56       * 
57       * @param name the new administrative name
58       */
59      public void setName(String name);
60  
61      /***
62       * Sets the descriptions
63       * 
64       * @param descriptions the new description
65       */
66      public void setDescriptions(DescriptionSet descriptions);
67  
68      /***
69       * Sets the display names
70       * 
71       * @param displayNames the new display names
72       */
73      public void setDisplayNames(DisplayNameSet displayNames);
74  
75  
76      /***
77       * Sets the class loader of the portlet
78       * 
79       * @param loader
80       */
81      public void setPortletClassLoader(ClassLoader loader);
82  
83      /***
84       * Stores the object persistently
85       * 
86       * @exception java.io.IOException
87       *                   in case of trouble fulfilling the request
88       */
89      public void store() throws java.io.IOException;
90  
91  
92  }