javax.portlet.RenderURL 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.
The newest version!
/*  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;


/**
 * 
 * This is a marker interface for a render URL.
 * 
 * A render URL is created with {@link MimeResponse#createRenderURL()}. 
 * 
 * @since   3.0
 */
public interface RenderURL extends PortletURL
{



   /**
    * 
    * Sets a fragment identifier on the URL.
    * 
    * Any previously set fragment identifier will be replaced.
    * 

    * The fragment identifier consists of additional information appended
    * to the URL after a '#' character. A URL can have only a single fragment
    * identifier. The fragment identifier must be formed according to 
    * rfc3986.
    * 

    * The fragment identifier is often used to address a named anchor such as 
    * <a name="#fragmentIdentifier">, but it can also be 
    * used for other purposes such as to pass information to a JavaScript routine.
    * 

    * The fragment identifier will not be namespaced. The portlet is responsible for 
    * performing any required namespacing. However, the fragment identifier string 
    * will be escaped as required.
    * 

    * Setting the fragment identifier to null will remove a 
    * fragment identifier previously set through this method. Setting the 
    * empty string as the fragment identifier will create an empty fragment 
    * identifier. 
    * 
    *
    * @param fragment
    *            The fragment identifier to be added to the URL
    *                
    * 
    * @see #getFragmentIdentifier
    */
   public void setFragmentIdentifier(String fragment);


   /**
    * 
    * Gets the fragment identifier previously set on the URL.
    * 
    * A fragment identifier may have been set by the portlet 
    * using the {@link #setFragmentIdentifier} method, or it may
    * be a value set by the portal if the portlet had not previously set a
    * fragment identifier.
    * 
    *
    * @return 
    *         The fragment identifier set on the URL, or 
    *         null if no fragment identifier has been set.
    *
    * @see #setFragmentIdentifier
    */
   public String getFragmentIdentifier();
}