javax.portlet.MutableRenderParameters Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of portlet-api Show documentation

The Java Portlet API version 3.0 developed by the Java Community Process JSR-362 Expert Group.

There is a newer version: 3.0.1

/*  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;

/**
 * 
 * Provides methods that allow  
 * setting parameters to define a potential future render state.
 * 
 * For example, these methods can be used to set render parameters on 
 * a PortletURL object. 
 * The modified parameters will be available during requests
 * triggered by the URL.
 * 

 * If the MutableRenderParameters object was retrieved from 
 * a response or a URL, changes made will be applied to that response or URL. 
 * The modified parameters will be available during subsequent requests as defined 
 * by the response or URL object. 
 * 

 * {@link RenderState} provides a description of the render state.
 * {@link PortletParameters} provides a description of the parameter concept.
 * 
 *
 * @see   RenderState
 * @see   MutablePortletParameters
 * @see   RenderParameters
 * @since 3.0
 */
public interface MutableRenderParameters extends 
         MutablePortletParameters, RenderParameters {
   
   
   /**
    * 
    * Clears all private parameters that are present in the 
    * MutableRenderParameters object.
    *  
    * @since 3.0
    */
   
   public void clearPrivate();
   
   
   /**
    * 
    * Clears all public parameters that are present in the 
    * MutableRenderParameters object.
    *  
    * @since 3.0
    */
   
   public void clearPublic();
}