source: trunk/autoquest-core-events/src/main/java/de/ugoe/cs/autoquest/IReplayDecorator.java @ 927

//   Copyright 2012 Georg-August-Universität Göttingen, Germany
//
//   Licensed 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 de.ugoe.cs.autoquest;

import java.io.Serializable;

/**
 * <p>
 * This interface defines the structure of decorators used when writing replay
 * files.
 * </p>
 * 
 * @author Steffen Herbold
 * @version 1.0
 */
public interface IReplayDecorator extends Serializable {

        /**
         * <p>
         * Header of the file. Called at the beginning of the writing.
         * </p>
         * 
         * @return file header
         */
        String getHeader();

        /**
         * <p>
         * Footer of the file. Called at the end of the writing.
         * </p>
         * 
         * @return file footer
         */
        String getFooter();

        /**
         * <p>
         * Session Header. Called before each session.
         * </p>
         * 
         * @param sessionId
         *            id of the session
         * @return session header
         */
        String getSessionHeader(int sessionId);

        /**
         * <p>
         * Session Footer. Called after each session.
         * </p>
         * 
         * @param sessionId
         *            id of the session
         * @return session footer
         */
        String getSessionFooter(int sessionId);
}