javax.portlet.RenderResponse Maven / Gradle / Ivy
Show all versions of portlet-api_2.1.0_spec 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 RenderResponse defines an object to assist a portlet in
* sending a response to the portal. It extends the MimeResponse
* interface to provide specific render response functionality to portlets.
* The portlet container creates a RenderResponse object and
* passes it as argument to the portlet's render method.
*
* @see RenderRequest
* @see PortletResponse
* @see MimeResponse
*/
public interface RenderResponse extends MimeResponse {
/**
* This method sets the title of the portlet.
*
* The value can be a text String
*
* @param title
* portlet title as text String or resource URI
*/
public void setTitle(String title);
/**
* This method allows the portlet to tell the portal the next possible
* portlet modes that the make sense from the portlet point of view.
*
* If set, the portal should honor these enumeration of portlet modes and
* only provide the end user with choices to the provided portlet modes or a
* subset of these modes based on access control considerations.
*
* If the portlet does not set any next possible portlet modes the default
* is that all portlet modes that the portlet has defined supporting in the
* portlet deployment descriptor are meaningful new portlet modes.
*
* @param portletModes
* Enumeration of PortletMode objects with the
* next possible portlet modes that the make sense from the
* portlet point of view, must not be null or an
* empty enumeration.
* @since 2.0
*/
public void setNextPossiblePortletModes(java.util.Collection portletModes);
/**
* Sets the MIME type for the render response. The portlet should set the
* content type before calling {@link #getWriter} or
* {@link #getPortletOutputStream}.
*
* Calling setContentType after getWriter or
* getOutputStream does not change the content type.
*
* The portlet container will ignore any character encoding
* specified as part of the content type for render
* calls.
*
* @param type
* the content MIME type
*
* @throws java.lang.IllegalArgumentException
* if the given type is not in the list
* returned by PortletRequest.getResponseContentTypes
*
* @see PortletRequest#getResponseContentTypes
* @see #getContentType
*/
public void setContentType(String type);
}