001// Copyright 2007, 2008 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.tapestry5.internal.services;
016
017import java.io.IOException;
018
019/**
020 * Used to render portions of a page as part of an {@linkplain AjaxComponentEventRequestHandler Ajax request}.    This
021 * encapsulates rendering of the partial response and then the construction of a {@linkplain
022 * org.apache.tapestry5.json.JSONObject JSON reply}. Works with the pipeline defined by the {@link
023 * org.apache.tapestry5.services.PartialMarkupRenderer} service.
024 *
025 * @see org.apache.tapestry5.internal.services.PageRenderQueue
026 */
027public interface AjaxPartialResponseRenderer
028{
029    /**
030     * Used to render a partial response as part of an Ajax action request. A call to {@link
031     * PageRenderQueue#addPartialRenderer(org.apache.tapestry5.runtime.RenderCommand)}
032     * should precede this call.
033     */
034    void renderPartialPageMarkup() throws IOException;
035}