001// Copyright 2005 The Apache Software Foundation
002//
003// Licensed under the Apache License, Version 2.0 (the "License");
004// you may not use this file except in compliance with the License.
005// You may obtain a copy of the License at
006//
007//     http://www.apache.org/licenses/LICENSE-2.0
008//
009// Unless required by applicable law or agreed to in writing, software
010// distributed under the License is distributed on an "AS IS" BASIS,
011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012// See the License for the specific language governing permissions and
013// limitations under the License.
014
015package org.apache.tapestry.portlet;
016
017/**
018 * @author Howard M. Lewis Ship
019 * @since 4.0
020 */
021public class PortletConstants
022{
023    /**
024     * Name of the render service, whose job is to render a page. The page to render is identified
025     * in the {@link org.apache.tapestry.services.ServiceConstants#PAGE} parameter.
026     */
027    public static final String RENDER_SERVICE = "render";
028
029    /**
030     * Name of the exception service, which renders stored exception markup.
031     */
032
033    public static final String EXCEPTION_SERVICE = "exception";
034
035    /**
036     * Session attribute key used to store markup generated during an action request, so that it can
037     * be displayed during a later render request.
038     */
039
040    public static final String PORTLET_EXCEPTION_MARKUP_ATTRIBUTE = "org.apache.tapestry.portlet.PortletExceptionMarkup";
041
042    /**
043     * Render parameter name storing the portlet mode at the time the render URL was created. This
044     * is necessary for determining when the mode has changed.
045     */
046
047    public static final String PORTLET_MODE = "portlet-mode";
048
049    /**
050     * Render parameter name storing the window state at the time the render URL was created. Again,
051     * this is necessary for determining when the window state has changed.
052     */
053
054    public static final String WINDOW_STATE = "window-state";
055
056    private PortletConstants()
057    {
058        // Prevent instantiation
059    }
060}