javax.portlet.PortalContext Maven / Gradle / Ivy
Show all versions of portlet-api Show documentation
/* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* This source code implements specifications defined by the Java
* Community Process. In order to remain compliant with the specification
* DO NOT add / change / or delete method signatures!
*/
package javax.portlet;
/**
* The PortalContext
interface gives the portlet
* the ability to retrieve information about the portal calling this portlet.
*
* The portlet can only read the PortalContext
data.
*/
public interface PortalContext
{
/**
* Property indicating if the portal application supports the
* MimeResponse
property MARKUP_HEAD_ELEMENT
.
*
* A non-null value indicates that the portal application supports
* the MARKUP_HEAD_ELEMENT
property.
*
* The value is "javax.portlet.markup.head.element.support"
.
*
* @since 2.0
*/
public static final String MARKUP_HEAD_ELEMENT_SUPPORT = "javax.portlet.markup.head.element.support";
/**
* Returns the portal property with the given name,
* or a null
if there is
* no property by that name.
*
* @param name property name
*
* @return portal property with key name
*
* @exception java.lang.IllegalArgumentException
* if name is null
.
*/
public java.lang.String getProperty(java.lang.String name);
/**
* Returns all portal property names, or an empty
* Enumeration
if there are no property names.
*
* @return All portal property names as an
* Enumeration
of String
objects
*/
public java.util.Enumeration getPropertyNames();
/**
* Returns all supported portlet modes by the portal
* as an enumeration of PortletMode
objects.
*
* The portlet modes must at least include the
* standard portlet modes EDIT, HELP, VIEW
.
*
* @return All supported portal modes by the portal
* as an enumeration of PortletMode
objects.
*/
public java.util.Enumeration getSupportedPortletModes();
/**
* Returns all supported window states by the portal
* as an enumeration of WindowState
objects.
*
* The window states must at least include the
* standard window states MINIMIZED, NORMAL, MAXIMIZED
.
*
* @return All supported window states by the portal
* as an enumeration of WindowState
objects.
*/
public java.util.Enumeration getSupportedWindowStates();
/**
* Returns information about the portal like vendor, version, etc.
*
* The form of the returned string is servername/versionnumber. For
* example, the reference implementation Pluto may return the string
* Pluto/1.0
.
*
* The portlet container may return other optional information after the
* primary string in parentheses, for example, Pluto/1.0
* (JDK 1.3.1; Windows NT 4.0 x86)
.
*
* @return a String
containing at least the portal name and version number
*/
public java.lang.String getPortalInfo();
}