/*
 * 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.
 */
package org.apache.asterix.common.api;

import org.apache.hyracks.api.exceptions.HyracksDataException;

public interface IResponsePrinter {

    /**
     * Performs any operations required before printing the response fields.
     */
    void begin();

    /**
     * Adds a response header printer.
     *
     * @param printer
     */
    void addHeaderPrinter(IResponseFieldPrinter printer);

    /**
     * Adds a response result printer.
     *
     * @param printer
     */
    void addResultPrinter(IResponseFieldPrinter printer);

    /**
     * Adds a response footer printer.
     *
     * @param printer
     */
    void addFooterPrinter(IResponseFieldPrinter printer);

    /**
     * Prints the added response headers.
     *
     * @throws HyracksDataException
     */
    void printHeaders() throws HyracksDataException;

    /**
     * Prints the added response results.
     *
     * @throws HyracksDataException
     */
    void printResults() throws HyracksDataException;

    /**
     * Prints the added response footers.
     *
     * @throws HyracksDataException
     */
    void printFooters() throws HyracksDataException;

    /**
     * Performs any operations required after printing the response fields.
     */
    void end();
}
