/*
 *  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.
 *  
 *  $Rev$  $Date$
 */
package test.sdo21.framework;

import test.sdo21.tests.ConsistencyTestTemplate;
import test.sdo21.tests.TestData.StandardFactory;
import test.sdo21.tests.TestData.TestDataFactory;
import test.sdo21.tests.api.CTSConsistencyBase;
import commonj.sdo.DataObject;
import commonj.sdo.helper.HelperContext;

/**
 * Vendors can provide an implementation of this interface to provide 
 * DataObjects in the appropriate manner for the test scenario.
 * @deprecated
 * @see TestDataFactory
 * @see CTSConsistencyBase
 * @see StandardFactory
 * @see ConsistencyTestTemplate
 */
public interface DataObjectFactory {

	/**
	 * Returns the scoped used for this DataObjectFactory
	 * @return
	 */
	public HelperContext getHelperContext();
	
	/**
	 * Returns the name of the static package used for this DataObjectFactory.
	 * Returns null in the case of dynamic.
	 * @return
	 */
	public String getPackage();
	
	/** 
	 * Creates and returns a DataObject of Type 'APITest'
	 * @return
	 */
	public DataObject createTestAPIObject();
	
	/**
	 * Creates and returns a DataObject of Type 'Sequenced'
	 * @return
	 */
	public DataObject createSequencedObject();
	
	/**
	 * Creates and returns a DataObject of Type 'Extended'
	 * @return
	 */
	public DataObject createExtendedObject();
}