/*

   Derby - Class org.apache.derby.iapi.store.raw.StreamContainerHandle

   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.derby.iapi.store.raw;

import org.apache.derby.shared.common.error.StandardException;

import org.apache.derby.iapi.types.DataValueDescriptor;

import java.util.Properties;

/**
	A Stream Container handle
*/

public interface StreamContainerHandle {

	public static final int TEMPORARY_SEGMENT = -1;

	/**
		Return my identifier.
	*/
	public ContainerKey getId();

    /**
     * Request the system properties associated with a container. 
     * <p>
     * Request the value of properties that are associated with a stream table.
	 * The following properties can be requested:
     *     derby.storage.streamFileBufferSize 
     * <p>
     * To get the value of a particular property add it to the property list,
     * and on return the value of the property will be set to it's current 
     * value.  For example:
     *
     * get_prop(ConglomerateController cc)
     * {
     *     Properties prop = new Properties();
     *     prop.put("derby.storage.streamFileBufferSize", "");
     *     cc.getTableProperties(prop);
     *
     *     System.out.println(
     *         "table's buffer size = " + 
     *         prop.getProperty("derby.storage.streamFileBufferSize");
     * }
     *
     * @param prop   Property list to fill in.
     *
	 * @exception  StandardException  Standard exception policy.
     **/
    void getContainerProperties(Properties prop)
		throws StandardException;

	/**
		Fetch the next record.
		Fills in the Storable columns within the passed in row if
		row is not null, otherwise the record is not fetched.
		If the row.length is less than the number of fields in the row,
		then, will fill the row, and ignore the rest of the row.
		<BR>
		When no more row is found, then false is returned.

		<P>
		<B>Locking Policy</B>
		<BR>
		No locks.

		@param row Row to be filled in with information from the record.

		@exception StandardException	Standard Derby error policy
	*/
	boolean fetchNext(DataValueDescriptor[] row) throws StandardException;

	/**
		Close me. After using this method the caller must throw away the
		reference to the Container object, e.g.
		<PRE>
			ref.close();
			ref = null;
		</PRE>
		<BR>
		The container will be closed automatically at the commit or abort
		of the transaction if this method is not called explictly.
	*/
	public void close();

	/**
		remove the stream container

		@exception StandardException Standard Derby error policy		
	 */
	public void removeContainer() throws StandardException;
}
