001    // Copyright Mar 18, 2006 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    package org.apache.tapestry;
015    
016    import org.apache.tapestry.json.IJSONWriter;
017    
018    
019    /**
020     * Defines a component/page/class that is capable of rendering json
021     * responses via {@link IJSONWriter} writers.
022     * 
023     * @author jkuhnert
024     */
025    public interface IJSONRender
026    {
027    
028        /**
029         * Renders a JSON object response back to the client. It should be assumed that
030         * if this method is called on a component it or one of the components it contains
031         * has been requested explicitly for rendering.
032         * 
033         * @param writer
034         *          The json object writer used to write valid JSON responses.
035         * @param cycle
036         *          Contextual request object.
037         */
038        void renderComponent(IJSONWriter writer, IRequestCycle cycle);
039    }