01: /**
02: * Copyright 2003 IBM Corporation and Sun Microsystems, Inc.
03: * All rights reserved.
04: * Use is subject to license terms.
05: */package javax.portlet;
06:
07: /**
08: * The <CODE>PortalContext</CODE> interface gives the portlet
09: * the ability to retrieve information about the portal calling this portlet.
10: * <p/>
11: * The portlet can only read the <CODE>PortalContext</CODE> data.
12: */
13: public interface PortalContext {
14:
15: /**
16: * Returns the portal property with the given name,
17: * or a <code>null</code> if there is
18: * no property by that name.
19: *
20: * @param name property name
21: * @return portal property with key <code>name</code>
22: * @exception java.lang.IllegalArgumentException if name is <code>null</code>.
23: */
24:
25: public java.lang.String getProperty(java.lang.String name);
26:
27: /**
28: * Returns all portal property names, or an empty
29: * <code>Enumeration</code> if there are no property names.
30: *
31: * @return All portal property names as an
32: * <code>Enumeration</code> of <code>String</code> objects
33: */
34: public java.util.Enumeration getPropertyNames();
35:
36: /**
37: * Returns all supported portlet modes by the portal
38: * as an enumertation of <code>PorltetMode</code> objects.
39: * <p/>
40: * The portlet modes must at least include the
41: * standard portlet modes <code>EDIT, HELP, VIEW</code>.
42: *
43: * @return All supported portal modes by the portal
44: * as an enumertation of <code>PorltetMode</code> objects.
45: */
46:
47: public java.util.Enumeration getSupportedPortletModes();
48:
49: /**
50: * Returns all supported window states by the portal
51: * as an enumertation of <code>WindowState</code> objects.
52: * <p/>
53: * The window states must at least include the
54: * standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.
55: *
56: * @return All supported window states by the portal
57: * as an enumertation of <code>WindowState</code> objects.
58: */
59:
60: public java.util.Enumeration getSupportedWindowStates();
61:
62: /**
63: * Returns information about the portal like vendor, version, etc.
64: * <p/>
65: * The form of the returned string is <I>servername/versionnumber</I>. For
66: * example, the reference implementation Pluto may return the string
67: * <CODE>Pluto/1.0</CODE>.
68: * <p/>
69: * The portlet container may return other optional information after the
70: * primary string in parentheses, for example, <CODE>Pluto/1.0
71: * (JDK 1.3.1; Windows NT 4.0 x86)</CODE>.
72: *
73: * @return a <CODE>String</CODE> containing at least the portal name and version number
74: */
75:
76: public java.lang.String getPortalInfo();
77: }
|