PortalContextProvider


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.services.information;
21  
22  
23  /**
24   * Provide information about the calling portal.
25   */
26  public interface PortalContextProvider 
27  {
28   
29      /**
30       * Returns the portal property with the given name, 
31       * or a <code>null</code> if there is 
32       * no property by that name.
33       *
34       * @param  name    property name
35       *
36       * @return  portal property with key <code>name</code>
37       *
38       * @exception   java.lang.IllegalArgumentException  
39       *                      if name is <code>null</code>.
40       */
41  
42      public java.lang.String   getProperty(java.lang.String   name);
43  
44  
45      /**
46       * Returns all portal property names as strings,
47       * or an empty <code>Collection</code> if 
48       * there are no property names.
49       *
50       * @return  portal property names
51       */
52      public java.util.Collection   getPropertyNames();
53  
54  
55      /**
56       * Returns the portlet modes that the portal supports 
57       * as <code>javax.portlet.PortletMode</code> objects.
58       * <p>
59       * The portlet modes must at least include the
60       * standard portlet modes <code>EDIT, HELP, VIEW</code>.
61       *
62       * @return  list of supported portlet modes
63       */
64   
65      public java.util.Collection   getSupportedPortletModes();
66  
67  
68      /**
69       * Returns the window states that the portal supports
70       * as <code>javax.portlet.WindowState</code> objects.
71       * <p>
72       * The window states must at least include the
73       * standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.
74       *
75       * @return  list of supported window states
76       */
77  
78      public java.util.Collection   getSupportedWindowStates();
79  
80  
81      /**
82       * Returns information about the portal like vendor, version, etc.
83       * <p>
84       * The returned string starts with <br>
85       * <I>servername/versionnumber</I>
86       * Other optional information follow the primary string in parentheses. 
87       * 
88       * @return a <CODE>String</CODE> containing at least the portal name and version number
89       */
90  
91      public java.lang.String   getPortalInfo();
92  
93  }
94
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags