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: *
22: * @return portal property with key <code>name</code>
23: *
24: * @exception java.lang.IllegalArgumentException
25: * if name is <code>null</code>.
26: */
27:
28: public java.lang.String getProperty(java.lang.String name);
29:
30: /**
31: * Returns all portal property names, or an empty
32: * <code>Enumeration</code> if there are no property names.
33: *
34: * @return All portal property names as an
35: * <code>Enumeration</code> of <code>String</code> objects
36: */
37: public java.util.Enumeration getPropertyNames();
38:
39: /**
40: * Returns all supported portlet modes by the portal
41: * as an enumertation of <code>PorltetMode</code> objects.
42: * <p>
43: * The portlet modes must at least include the
44: * standard portlet modes <code>EDIT, HELP, VIEW</code>.
45: *
46: * @return All supported portal modes by the portal
47: * as an enumertation of <code>PorltetMode</code> objects.
48: */
49:
50: public java.util.Enumeration getSupportedPortletModes();
51:
52: /**
53: * Returns all supported window states by the portal
54: * as an enumertation of <code>WindowState</code> objects.
55: * <p>
56: * The window states must at least include the
57: * standard window states <code> MINIMIZED, NORMAL, MAXIMIZED</code>.
58: *
59: * @return All supported window states by the portal
60: * as an enumertation of <code>WindowState</code> objects.
61: */
62:
63: public java.util.Enumeration getSupportedWindowStates();
64:
65: /**
66: * Returns information about the portal like vendor, version, etc.
67: * <p>
68: * The form of the returned string is <I>servername/versionnumber</I>. For
69: * example, the reference implementation Pluto may return the string
70: * <CODE>Pluto/1.0</CODE>.
71: * <p>
72: * The portlet container may return other optional information after the
73: * primary string in parentheses, for example, <CODE>Pluto/1.0
74: * (JDK 1.3.1; Windows NT 4.0 x86)</CODE>.
75: *
76: * @return a <CODE>String</CODE> containing at least the portal name and version number
77: */
78:
79: public java.lang.String getPortalInfo();
80: }
|