org.bndly.testfixture.api.TestFixtureDao Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.bndly.common.testfixture.resource Show documentation
The newest version!
/*
 * Copyright (c) 2012, cyber:con GmbH, Bonn.
 *
 * All rights reserved. This source file is provided to you for
 * documentation purposes only. No part of this file may be
 * reproduced or copied in any form without the written
 * permission of cyber:con GmbH. No liability can be accepted
 * for errors in the program or in the documentation or for damages
 * which arise through using the program. If an error is discovered,
 * cyber:con GmbH will endeavour to correct it as quickly as possible.
 * The use of the program occurs exclusively under the conditions
 * of the licence contract with cyber:con GmbH.
 */
package org.bndly.testfixture.api;

/*-
 * #%L
 * Test Fixture Resource
 * %%
 * Copyright (C) 2013 - 2020 Cybercon GmbH
 * %%
 * 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.
 * #L%
 */

import org.bndly.schema.fixtures.api.FixtureDeploymentException;
import org.bndly.testfixture.model.TestFixture;
import java.io.Writer;

/**
 * TestFixture DAO API for Setting and Getting the current TestFixture.
 */
public interface TestFixtureDao {
	String NAME = "testFixtureDao";
	
	/**
	 * Establish a new Test Fixture described by testFixture being passed-in.
	 */
	void doEstablishTestFixture(TestFixture testFixture) throws FixtureDeploymentException;
	
	/**
	 * Gets a fixture json document as a string
	 * 
	 * @return DataSet as a String
	 */
	String getCurrentTestFixture(String schemaName) throws FixtureDeploymentException;
	
	/**
	 * Writes a fixture json document
	 */
	void writeCurrentTestFixture(String schemaName, Writer writer) throws FixtureDeploymentException;
}